http://github.com/org/folio/mod-feesfines
This documents the API calls that can be made to query and manage manualblock of the system
Collection of manualblock items.
Return a list of manualblocks
GET /manualblocks
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.
with valid searchable fields
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
active=true
Order by field: field A, field B
Order
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
Skip over a number of elements by specifying an offset value for the query
Example:
0
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
Returns a list of manualblock items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of manualblocks",
"type": "object",
"properties": {
"manualblocks": {
"description": "List of manualblock items",
"type": "array",
"id": "manualblocksData",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Manual patron block schema",
"description": "Allows institution to manually block a patron from borrowing, renewing, and/or requesting until specified issue is resolved",
"properties": {
"type": {
"description": "Type of patron block",
"type": "string"
},
"desc": {
"description": "Patron block description",
"type": "string"
},
"code": {
"description": "Code of the template if block is defined based on a template (optional)",
"type": "string"
},
"staffInformation": {
"description": "Additional information to staff (optional)",
"type": "string"
},
"patronMessage": {
"description": "Message to patron (optional)",
"type": "string"
},
"expirationDate": {
"description": "Date and time the patron block expiration if is provided the patron block should be automatically removed on that date",
"type": "string",
"format": "date-time"
},
"borrowing": {
"description": "A flag to determine borrowing block action",
"type": "boolean"
},
"renewals": {
"description": "A flag to determine renewal block action",
"type": "boolean"
},
"requests": {
"description": "A flag to determine request block action",
"type": "boolean"
},
"userId": {
"description": "ID of the user",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"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}$"
},
"metadata": {
"description": "Metadata about creation to patron block, provided by the server",
"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"
]
},
"id": {
"description": "Patron block id, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"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}$"
}
},
"additionalProperties": false,
"required": [
"desc",
"userId"
]
}
},
"totalRecords": {
"type": "integer"
}
},
"required": [
"manualblocks",
"totalRecords"
]
}
Example:
{
"manualblocks": [
{
"type": "Manual",
"desc": "Invalid email and mailing addresses.",
"staffInformation": "Last 3 have bounced back and the letter we sent was returned to us.",
"patronMessage": "Please contact the Main Library to update your contact information.",
"expirationDate": "2018-10-23T00:00:00Z",
"borrowing": true,
"renewals": true,
"requests": true,
"metadata": {
"createdDate": "2018-10-16T23:07:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-10-16T23:07:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"userId": "630824a0-a8ad-49f3-b5e2-3f2fe6ef5916",
"id": "46399627-08a9-414f-b91c-a8a7ec850d03"
}
],
"totalRecords": 1
}
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.
Media type: text/plain
Type: any
Example:
unable to list manualblocks -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list manualblocks -- unauthorized
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Create a manualblock
POST /manualblocks
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Manual patron block schema",
"description": "Allows institution to manually block a patron from borrowing, renewing, and/or requesting until specified issue is resolved",
"type": "object",
"properties": {
"type": {
"description": "Type of patron block",
"type": "string"
},
"desc": {
"description": "Patron block description",
"type": "string"
},
"code": {
"description": "Code of the template if block is defined based on a template (optional)",
"type": "string"
},
"staffInformation": {
"description": "Additional information to staff (optional)",
"type": "string"
},
"patronMessage": {
"description": "Message to patron (optional)",
"type": "string"
},
"expirationDate": {
"description": "Date and time the patron block expiration if is provided the patron block should be automatically removed on that date",
"type": "string",
"format": "date-time"
},
"borrowing": {
"description": "A flag to determine borrowing block action",
"type": "boolean"
},
"renewals": {
"description": "A flag to determine renewal block action",
"type": "boolean"
},
"requests": {
"description": "A flag to determine request block action",
"type": "boolean"
},
"userId": {
"description": "ID of the user",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"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}$"
},
"metadata": {
"description": "Metadata about creation to patron block, provided by the server",
"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"
]
},
"id": {
"description": "Patron block id, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"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}$"
}
},
"additionalProperties": false,
"required": [
"desc",
"userId"
]
}
Example:
{
"type": "Manual",
"desc": "Invalid email and mailing addresses.",
"staffInformation": "Last 3 have bounced back and the letter we sent was returned to us.",
"patronMessage": "Please contact the Main Library to update your contact information.",
"expirationDate": "2018-10-23T00:00:00Z",
"borrowing": true,
"renewals": true,
"requests": true,
"metadata": {
"createdDate": "2018-10-16T23:07:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-10-16T23:07:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"userId": "630824a0-a8ad-49f3-b5e2-3f2fe6ef5916",
"id": "46399627-08a9-414f-b91c-a8a7ec850d03"
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created manualblock item
Media type: application/json
Type: any
Example:
{
"type": "Manual",
"desc": "Invalid email and mailing addresses.",
"staffInformation": "Last 3 have bounced back and the letter we sent was returned to us.",
"patronMessage": "Please contact the Main Library to update your contact information.",
"expirationDate": "2018-10-23T00:00:00Z",
"borrowing": true,
"renewals": true,
"requests": true,
"metadata": {
"createdDate": "2018-10-16T23:07:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-10-16T23:07:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"userId": "630824a0-a8ad-49f3-b5e2-3f2fe6ef5916",
"id": "46399627-08a9-414f-b91c-a8a7ec850d03"
}
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.
Media type: text/plain
Type: any
Example:
"unable to add manualblock -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create manualblocks -- unauthorized
Validation errors
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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Get a single manualblock
GET /manualblocks/{manualblockId}
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Manual patron block schema",
"description": "Allows institution to manually block a patron from borrowing, renewing, and/or requesting until specified issue is resolved",
"type": "object",
"properties": {
"type": {
"description": "Type of patron block",
"type": "string"
},
"desc": {
"description": "Patron block description",
"type": "string"
},
"code": {
"description": "Code of the template if block is defined based on a template (optional)",
"type": "string"
},
"staffInformation": {
"description": "Additional information to staff (optional)",
"type": "string"
},
"patronMessage": {
"description": "Message to patron (optional)",
"type": "string"
},
"expirationDate": {
"description": "Date and time the patron block expiration if is provided the patron block should be automatically removed on that date",
"type": "string",
"format": "date-time"
},
"borrowing": {
"description": "A flag to determine borrowing block action",
"type": "boolean"
},
"renewals": {
"description": "A flag to determine renewal block action",
"type": "boolean"
},
"requests": {
"description": "A flag to determine request block action",
"type": "boolean"
},
"userId": {
"description": "ID of the user",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"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}$"
},
"metadata": {
"description": "Metadata about creation to patron block, provided by the server",
"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"
]
},
"id": {
"description": "Patron block id, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"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}$"
}
},
"additionalProperties": false,
"required": [
"desc",
"userId"
]
}
Example:
{
"type": "Manual",
"desc": "Invalid email and mailing addresses.",
"staffInformation": "Last 3 have bounced back and the letter we sent was returned to us.",
"patronMessage": "Please contact the Main Library to update your contact information.",
"expirationDate": "2018-10-23T00:00:00Z",
"borrowing": true,
"renewals": true,
"requests": true,
"metadata": {
"createdDate": "2018-10-16T23:07:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-10-16T23:07:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"userId": "630824a0-a8ad-49f3-b5e2-3f2fe6ef5916",
"id": "46399627-08a9-414f-b91c-a8a7ec850d03"
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"manualblock not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete manualblock item with given {manualblockId}
DELETE /manualblocks/{manualblockId}
Item deleted successfully
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.
Media type: text/plain
Type: any
Example:
"unable to delete manualblock -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"manualblock not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Update manualblock item with given {manualblockId}
PUT /manualblocks/{manualblockId}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "Manual patron block schema",
"description": "Allows institution to manually block a patron from borrowing, renewing, and/or requesting until specified issue is resolved",
"type": "object",
"properties": {
"type": {
"description": "Type of patron block",
"type": "string"
},
"desc": {
"description": "Patron block description",
"type": "string"
},
"code": {
"description": "Code of the template if block is defined based on a template (optional)",
"type": "string"
},
"staffInformation": {
"description": "Additional information to staff (optional)",
"type": "string"
},
"patronMessage": {
"description": "Message to patron (optional)",
"type": "string"
},
"expirationDate": {
"description": "Date and time the patron block expiration if is provided the patron block should be automatically removed on that date",
"type": "string",
"format": "date-time"
},
"borrowing": {
"description": "A flag to determine borrowing block action",
"type": "boolean"
},
"renewals": {
"description": "A flag to determine renewal block action",
"type": "boolean"
},
"requests": {
"description": "A flag to determine request block action",
"type": "boolean"
},
"userId": {
"description": "ID of the user",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"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}$"
},
"metadata": {
"description": "Metadata about creation to patron block, provided by the server",
"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"
]
},
"id": {
"description": "Patron block id, UUID",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "uuid.schema",
"type": "string",
"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}$"
}
},
"additionalProperties": false,
"required": [
"desc",
"userId"
]
}
Example:
{
"type": "Manual",
"desc": "Invalid email and mailing addresses.",
"staffInformation": "Last 3 have bounced back and the letter we sent was returned to us.",
"patronMessage": "Please contact the Main Library to update your contact information.",
"expirationDate": "2018-10-23T00:00:00Z",
"borrowing": true,
"renewals": true,
"requests": true,
"metadata": {
"createdDate": "2018-10-16T23:07:02Z",
"createdByUserId": "1ad737b0-d847-11e6-bf26-cec0c932ce02",
"createdByUsername": "Doe",
"updatedDate": "2018-10-16T23:07:02Z",
"updatedByUserId": "695540df-cf63-4c67-91c1-d8746920d1dd",
"updatedByUsername": "robertjones"
},
"userId": "630824a0-a8ad-49f3-b5e2-3f2fe6ef5916",
"id": "46399627-08a9-414f-b91c-a8a7ec850d03"
}
Item successfully updated
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.
Media type: text/plain
Type: any
Example:
"unable to update manualblock -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"manualblock not found"
Optimistic locking version conflict
Media type: text/plain
Type: any
Example:
version conflict
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator