Patron Block Conditions version v0.1
http://github.com/org/folio/mod-users
mod-users Patron Block Conditions API
Query and manage each condition that can trigger a patron block and the messages that should be displayed when triggered.
/patron-block-conditions
Entity representing a patron-block-condition
get
Return a list of patron block conditions
get /patron-block-conditions
Return a list of patron block conditions
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
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of available conditions",
"type": "object",
"properties": {
"patronBlockConditions": {
"description": "List of of available patron block conditions",
"id": "patronBlockConditions",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Patron block conditions schema",
"properties": {
"id": {
"type": "string",
"description": "A UUID identifying the condition",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"name": {
"type": "string",
"description": "The name of the condition"
},
"blockBorrowing": {
"type": "boolean",
"description": "This flag indicates the block for borrowings"
},
"blockRenewals": {
"type": "boolean",
"description": "This flag indicates the block for renewals"
},
"blockRequests": {
"type": "boolean",
"description": "This flag indicates the block for requests"
},
"valueType": {
"type": "string",
"description": "Defines limit type",
"enum": [
"Integer",
"Double"
]
},
"message": {
"type": "string",
"description": "A message to be displayed"
},
"metadata": {
"type": "object",
"description": "Metadata about creation and changes to patron block conditions, provided by the server (client should not provide)",
"$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"
]
}
},
"required": [
"id",
"name",
"blockBorrowing",
"blockRenewals",
"blockRequests",
"valueType"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"additionalProperties": false,
"required": [
"patronBlockConditions",
"totalRecords"
]
}Example:
{
"patronBlockConditions": [
{
"id": "3d7c52dc-c732-4223-8bf8-e5917801386f",
"name": "Maximum number of items charged out",
"blockBorrowing": false,
"blockRenewals": true,
"blockRequests": false,
"valueType": "Integer",
"message": "The maximum number of charged out items has been reached"
},
{
"id": "72b67965-5b73-4840-bc0b-be8f3f6e047e",
"name": "Maximum number of lost items",
"blockBorrowing": true,
"blockRenewals": true,
"blockRequests": true,
"valueType": "Integer",
"message": "The maximum number of lost items has been reached"
},
{
"id": "584fbd4f-6a34-4730-a6ca-73a6a6a9d845",
"name": "Maximum number of overdue items",
"blockBorrowing": true,
"blockRenewals": true,
"blockRequests": true,
"valueType": "Integer",
"message": "The maximum number of overdue items has been reached"
},
{
"id": "e5b45031-a202-4abb-917b-e1df9346fe2c",
"name": "Maximum number of overdue recalls",
"blockBorrowing": true,
"blockRenewals": false,
"blockRequests": false,
"valueType": "Integer",
"message": "The maximum number of overdue recalls has been reached"
},
{
"id": "cf7a0d5f-a327-4ca1-aa9e-dc55ec006b8a",
"name": "Maximum outstanding fee/fine balance",
"blockBorrowing": true,
"blockRenewals": false,
"blockRequests": false,
"valueType": "Double",
"message": "The maximum outstanding fee/fine balance has been reached"
},
{
"id": "08530ac4-07f2-48e6-9dda-a97bc2bf7053",
"name": "Recall overdue by maximum number of days",
"blockBorrowing": true,
"blockRenewals": false,
"blockRequests": false,
"valueType": "Integer",
"message": "The recall overdue by maximum number of days has been reached"
}
],
"totalRecords": 6
}
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to list patron-block-conditions -- malformed parameter 'query', syntax error at column 6"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
"unable to list patron-block-conditions -- unauthorized"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"patron-block-condition not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorEntity representing a patron-block-condition
put
Update <<resourcePathName|!singularize>> item with given {<<resourcePathName|!singularize>>Id}
get
Retrieve patron-block-condition item with given {patron-block-conditionId}
put /patron-block-conditions/{patronBlockConditionId}
Update <<resourcePathName|!singularize>> item with given {<<resourcePathName|!singularize>>Id}
URI Parameters
- patronBlockConditionId: required(string)
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Patron block conditions schema",
"properties": {
"id": {
"type": "string",
"description": "A UUID identifying the condition",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"name": {
"type": "string",
"description": "The name of the condition"
},
"blockBorrowing": {
"type": "boolean",
"description": "This flag indicates the block for borrowings"
},
"blockRenewals": {
"type": "boolean",
"description": "This flag indicates the block for renewals"
},
"blockRequests": {
"type": "boolean",
"description": "This flag indicates the block for requests"
},
"valueType": {
"type": "string",
"description": "Defines limit type",
"enum": [
"Integer",
"Double"
]
},
"message": {
"type": "string",
"description": "A message to be displayed"
},
"metadata": {
"type": "object",
"description": "Metadata about creation and changes to patron block conditions, provided by the server (client should not provide)",
"$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"
]
}
},
"required": [
"id",
"name",
"blockBorrowing",
"blockRenewals",
"blockRequests",
"valueType"
]
}Example:
exampleItemHTTP status code 204
Item successfully updated
HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
"unable to update <<resourcePathName|!singularize>> -- malformed JSON at 13:4"
HTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"<<resourcePathName|!singularize>> not found"
HTTP status code 422
Validation errors
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"
}
}
}Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorget /patron-block-conditions/{patronBlockConditionId}
Retrieve patron-block-condition item with given {patron-block-conditionId}
URI Parameters
- patronBlockConditionId: required(string)
HTTP status code 200
Returns item with a given ID
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "Patron block conditions schema",
"properties": {
"id": {
"type": "string",
"description": "A UUID identifying the condition",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
},
"name": {
"type": "string",
"description": "The name of the condition"
},
"blockBorrowing": {
"type": "boolean",
"description": "This flag indicates the block for borrowings"
},
"blockRenewals": {
"type": "boolean",
"description": "This flag indicates the block for renewals"
},
"blockRequests": {
"type": "boolean",
"description": "This flag indicates the block for requests"
},
"valueType": {
"type": "string",
"description": "Defines limit type",
"enum": [
"Integer",
"Double"
]
},
"message": {
"type": "string",
"description": "A message to be displayed"
},
"metadata": {
"type": "object",
"description": "Metadata about creation and changes to patron block conditions, provided by the server (client should not provide)",
"$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"
]
}
},
"required": [
"id",
"name",
"blockBorrowing",
"blockRenewals",
"blockRequests",
"valueType"
]
}Example:
{
"id": "3d7c52dc-c732-4223-8bf8-e5917801386f",
"name": "Maximum number of items charged out",
"blockBorrowing": true,
"blockRenewals": false,
"blockRequests": false,
"valueType": "Integer",
"message": "The maximum number of charged out items has been reached"
}
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to get retrieve patron-block-condition -- unauthorizedHTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
"patron-block-condition not found"
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administrator