Patron Notice API (v1)

https://github.com/folio-org/mod-notify

Table of contents

mod-notify API

This documents the API calls that can be made to post patron notices for users

Patron Notice

API for sendig Patron Notices

POST /patron-notice

POST /patron-notice
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Response 200

Successfull request

Response 422

Unprocessable entity, e.g. incorrect template id or recipient id

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "total_records": {
      "type": "integer"
    }
  }
}

Response 500

Internal Server Error

Body

Media type: text/plain

Type: any