Patron Notice Policies version v0.13
http://localhost:9130
Patron Notice Policies API
Storage for Patron Notice Policies
/patron-notice-policy-storage
get
Get Patron Notice Policy list
post
Create new Patron Notice Policy
get /patron-notice-policy-storage/patron-notice-policies
Get Patron Notice Policy list
Query Parameters
- totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
none - offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
0 - limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
10 - query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
searchable using CQL
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode name="undergrad*"
HTTP status code 200
Return Patron Notice Policy list
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of patron notice policies",
"type": "object",
"properties": {
"patronNoticePolicies": {
"description": "List of patron notice policies",
"id": "patronNoticePolicies",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"description": "Patron notice policy",
"properties": {
"id": {
"type": "string",
"description": "Patron notice policy id, UUID"
},
"name": {
"type": "string",
"description": "Patron notice policy name"
},
"description": {
"type": "string",
"description": "Patron notice policy description"
},
"active": {
"type": "boolean",
"description": "A flag to determine if a patron notice policy is active"
},
"metadata": {
"description": "Metadata about creation and changes to policy, provided by the server (client should not provide)",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"loanNotices": {
"type": "array",
"description": "List of loan notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Due date",
"Renewed",
"Check in",
"Check out",
"Manual due date change",
"Item recalled",
"Aged to lost"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"feeFineNotices": {
"type": "array",
"description": "List of fee/fine notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent: after or upon",
"enum": [
"Upon At",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Overdue fine returned",
"Overdue fine renewed",
"Aged to lost - fine charged",
"Aged to lost & item returned - fine adjusted",
"Aged to lost & item replaced - fine adjusted"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"requestNotices": {
"type": "array",
"description": "List of request notice",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "User initiated and time driven events for request related notices",
"enum": [
"Recall request",
"Hold request",
"Request expiration",
"Paging request",
"Available",
"Hold expiration",
"Request cancellation"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
}
},
"required": [
"name"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"patronNoticePolicies",
"totalRecords"
]
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorpost /patron-notice-policy-storage/patron-notice-policies
Create new Patron Notice Policy
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"description": "Patron notice policy",
"properties": {
"id": {
"type": "string",
"description": "Patron notice policy id, UUID"
},
"name": {
"type": "string",
"description": "Patron notice policy name"
},
"description": {
"type": "string",
"description": "Patron notice policy description"
},
"active": {
"type": "boolean",
"description": "A flag to determine if a patron notice policy is active"
},
"metadata": {
"description": "Metadata about creation and changes to policy, provided by the server (client should not provide)",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"loanNotices": {
"type": "array",
"description": "List of loan notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Due date",
"Renewed",
"Check in",
"Check out",
"Manual due date change",
"Item recalled",
"Aged to lost"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"feeFineNotices": {
"type": "array",
"description": "List of fee/fine notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent: after or upon",
"enum": [
"Upon At",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Overdue fine returned",
"Overdue fine renewed",
"Aged to lost - fine charged",
"Aged to lost & item returned - fine adjusted",
"Aged to lost & item replaced - fine adjusted"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"requestNotices": {
"type": "array",
"description": "List of request notice",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "User initiated and time driven events for request related notices",
"enum": [
"Recall request",
"Hold request",
"Request expiration",
"Paging request",
"Available",
"Hold expiration",
"Request cancellation"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
}
},
"required": [
"name"
]
}HTTP status code 201
Successfully created
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"description": "Patron notice policy",
"properties": {
"id": {
"type": "string",
"description": "Patron notice policy id, UUID"
},
"name": {
"type": "string",
"description": "Patron notice policy name"
},
"description": {
"type": "string",
"description": "Patron notice policy description"
},
"active": {
"type": "boolean",
"description": "A flag to determine if a patron notice policy is active"
},
"metadata": {
"description": "Metadata about creation and changes to policy, provided by the server (client should not provide)",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"loanNotices": {
"type": "array",
"description": "List of loan notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Due date",
"Renewed",
"Check in",
"Check out",
"Manual due date change",
"Item recalled",
"Aged to lost"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"feeFineNotices": {
"type": "array",
"description": "List of fee/fine notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent: after or upon",
"enum": [
"Upon At",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Overdue fine returned",
"Overdue fine renewed",
"Aged to lost - fine charged",
"Aged to lost & item returned - fine adjusted",
"Aged to lost & item replaced - fine adjusted"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"requestNotices": {
"type": "array",
"description": "List of request notice",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "User initiated and time driven events for request related notices",
"enum": [
"Recall request",
"Hold request",
"Request expiration",
"Paging request",
"Available",
"Hold expiration",
"Request cancellation"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
}
},
"required": [
"name"
]
}HTTP status code 422
Unprocessable entity
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errorget
Get Patron Notice Policy by id
delete
Delete Patron Notice Policy by id
put
Update Patron Notice Policy by id
get /patron-notice-policy-storage/patron-notice-policies/{patronNoticePolicyId}
Get Patron Notice Policy by id
URI Parameters
- patronNoticePolicyId: required(string)
HTTP status code 200
Return Patron Notice Policy
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"description": "Patron notice policy",
"properties": {
"id": {
"type": "string",
"description": "Patron notice policy id, UUID"
},
"name": {
"type": "string",
"description": "Patron notice policy name"
},
"description": {
"type": "string",
"description": "Patron notice policy description"
},
"active": {
"type": "boolean",
"description": "A flag to determine if a patron notice policy is active"
},
"metadata": {
"description": "Metadata about creation and changes to policy, provided by the server (client should not provide)",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"loanNotices": {
"type": "array",
"description": "List of loan notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Due date",
"Renewed",
"Check in",
"Check out",
"Manual due date change",
"Item recalled",
"Aged to lost"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"feeFineNotices": {
"type": "array",
"description": "List of fee/fine notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent: after or upon",
"enum": [
"Upon At",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Overdue fine returned",
"Overdue fine renewed",
"Aged to lost - fine charged",
"Aged to lost & item returned - fine adjusted",
"Aged to lost & item replaced - fine adjusted"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"requestNotices": {
"type": "array",
"description": "List of request notice",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "User initiated and time driven events for request related notices",
"enum": [
"Recall request",
"Hold request",
"Request expiration",
"Paging request",
"Available",
"Hold expiration",
"Request cancellation"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
}
},
"required": [
"name"
]
}HTTP status code 404
Not found
Body
Media type: text/plain
Type: any
Example:
Not foundHTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server errordelete /patron-notice-policy-storage/patron-notice-policies/{patronNoticePolicyId}
Delete Patron Notice Policy by id
URI Parameters
- patronNoticePolicyId: required(string)
HTTP status code 204
Source record deleted
HTTP status code 400
Bad request, e.g. malformed request body, query parameter or constraint violation.
Body
Media type: text/plain
Type: any
Example:
Cannot delete in use notice policyHTTP status code 404
There is no source record for that patronNoticePolicyId
Body
Media type: text/plain
Type: any
Example:
Not foundHTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server errorput /patron-notice-policy-storage/patron-notice-policies/{patronNoticePolicyId}
Update Patron Notice Policy by id
URI Parameters
- patronNoticePolicyId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"description": "Patron notice policy",
"properties": {
"id": {
"type": "string",
"description": "Patron notice policy id, UUID"
},
"name": {
"type": "string",
"description": "Patron notice policy name"
},
"description": {
"type": "string",
"description": "Patron notice policy description"
},
"active": {
"type": "boolean",
"description": "A flag to determine if a patron notice policy is active"
},
"metadata": {
"description": "Metadata about creation and changes to policy, provided by the server (client should not provide)",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "metadata.schema",
"title": "Metadata Schema",
"properties": {
"createdDate": {
"description": "Date and time when the record was created",
"type": "string",
"format": "date-time"
},
"createdByUserId": {
"description": "ID of the user who created the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"createdByUsername": {
"description": "Username of the user who created the record (when available)",
"type": "string"
},
"updatedDate": {
"description": "Date and time when the record was last updated",
"type": "string",
"format": "date-time"
},
"updatedByUserId": {
"description": "ID of the user who last updated the record (when available)",
"type": "string",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
},
"updatedByUsername": {
"description": "Username of the user who last updated the record (when available)",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"createdDate"
]
},
"loanNotices": {
"type": "array",
"description": "List of loan notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Due date",
"Renewed",
"Check in",
"Check out",
"Manual due date change",
"Item recalled",
"Aged to lost"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"feeFineNotices": {
"type": "array",
"description": "List of fee/fine notices",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent: after or upon",
"enum": [
"Upon At",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "Triggering event",
"enum": [
"Overdue fine returned",
"Overdue fine renewed",
"Aged to lost - fine charged",
"Aged to lost & item returned - fine adjusted",
"Aged to lost & item replaced - fine adjusted"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
},
"requestNotices": {
"type": "array",
"description": "List of request notice",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Notice name"
},
"templateId": {
"type": "string",
"description": "Template id, UUID"
},
"templateName": {
"type": "string",
"description": "Template name"
},
"format": {
"type": "string",
"description": "Notice format, send through email, sms etc.",
"enum": [
"Email",
"SMS",
"Print"
]
},
"frequency": {
"type": "string",
"description": "Frequency, send it once or more",
"enum": [
"One time",
"Recurring"
]
},
"realTime": {
"type": "boolean",
"description": "Is this real time event"
},
"sendOptions": {
"type": "object",
"description": "Notice sending options",
"additionalProperties": false,
"properties": {
"sendHow": {
"type": "string",
"description": "Defines how notice should be sent, before, after or upon",
"enum": [
"Upon At",
"Before",
"After"
]
},
"sendWhen": {
"type": "string",
"description": "User initiated and time driven events for request related notices",
"enum": [
"Recall request",
"Hold request",
"Request expiration",
"Paging request",
"Available",
"Hold expiration",
"Request cancellation"
]
},
"sendBy": {
"type": "object",
"description": "Delay before the first attempt to send a notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
},
"sendEvery": {
"type": "object",
"description": "Interval between attempts to send a recurring notice",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"duration": {
"type": "integer",
"description": "Interval duration, number of time units",
"minimum": 1,
"maximum": 100
},
"intervalId": {
"type": "string",
"description": "Unit of time",
"enum": [
"Minutes",
"Hours",
"Days",
"Weeks",
"Months",
"Years"
]
}
},
"required": [
"duration",
"intervalId"
],
"additionalProperties": false
}
},
"required": [
"sendWhen"
]
}
},
"required": [
"templateId",
"format",
"realTime"
]
}
}
},
"required": [
"name"
]
}HTTP status code 204
Successfully updated
HTTP status code 404
Not found
Body
Media type: text/plain
Type: any
Example:
Not foundHTTP status code 422
Unprocessable entity
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "errors.schema",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "error.schema",
"description": "An error",
"properties": {
"message": {
"type": "string",
"description": "Error message text"
},
"type": {
"type": "string",
"description": "Error message type"
},
"code": {
"type": "string",
"description": "Error message code"
},
"parameters": {
"description": "Error message parameters",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "parameters.schema",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"message"
]
}
},
"total_records": {
"description": "Total number of errors",
"type": "integer"
}
}
}HTTP status code 500
Internal server error
Body
Media type: text/plain
Type: any
Example:
Internal server error