Templates for Manual Patron Blocks

/manual-block-templates

Collection of manual-block-template items.

/manual-block-templates get post

get

Return a list of manualblock templates

post

Create a manualblock template

Return a list of manualblock templates

Request
Response

Query Parameters

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.
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
```
orderBy: (string)
Order by field: field A, field B
order: (one of desc, asc - default: desc)
Order
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
```

HTTP status code 200

Returns a list of manual-block-template items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of manual-block templates",
  "type": "object",
  "properties": {
    "manualBlockTemplates": {
      "description": "List of manual-block templates",
      "type": "array",
      "id": "manualBlockTemplate",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "Manual patron block template schema",
        "description": "Allows institution to specify a template for manual patron blocks.",
        "properties": {
          "name": {
            "description": "Name of the template",
            "type": "string"
          },
          "code": {
            "description": "Code of the template. Can be a shorthand of the name (e.g. an acronym).",
            "type": "string"
          },
          "desc": {
            "description": "Description of this template",
            "type": "string"
          },
          "blockTemplate": {
            "type": "object",
            "description": "Contains the actual template values",
            "properties": {
              "desc": {
                "description": "Description of the patron block",
                "type": "string"
              },
              "patronMessage": {
                "description": "Message to patron (optional)",
                "type": "string"
              },
              "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"
              }
            }
          },
          "metadata": {
            "description": "Metadata about creation of the patron block template, 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": "Template 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": [
          "name"
        ]
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "manualBlockTemplates",
    "totalRecords"
  ]
}

Example:

{
  "manualBlockTemplates": [
   {
     "name": "Reader card lost",
     "code": "RCL",
     "desc": "Template to use if a patron lost his/her reader card",
     "blockTemplate": {
       "desc": "Reader card lost",
       "patronMessage": "Please contact the library's service desk for a new reader card.",
       "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"
     },
     "id": "a6905826-d84e-4900-a1f8-de1e3829d18d"
   }
  ],
  "totalRecords": 1
}

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 manual-block-templates -- 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 manual-block-templates -- unauthorized

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

Create a manualblock template

Request
Response

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Manual patron block template schema",
  "description": "Allows institution to specify a template for manual patron blocks.",
  "type": "object",
  "properties": {
    "name": {
      "description": "Name of the template",
      "type": "string"
    },
    "code": {
      "description": "Code of the template. Can be a shorthand of the name (e.g. an acronym).",
      "type": "string"
    },
    "desc": {
      "description": "Description of this template",
      "type": "string"
    },
    "blockTemplate": {
      "type": "object",
      "description": "Contains the actual template values",
      "properties": {
        "desc": {
          "description": "Description of the patron block",
          "type": "string"
        },
        "patronMessage": {
          "description": "Message to patron (optional)",
          "type": "string"
        },
        "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"
        }
      }
    },
    "metadata": {
      "description": "Metadata about creation of the patron block template, 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": "Template 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": [
    "name"
  ]
}

Example:

{
  "name": "Reader card lost",
  "code": "RCL",
  "desc": "Template to use if a patron lost his/her reader card",
  "blockTemplate": {
    "desc": "Reader card lost",
    "patronMessage": "Please contact the library's service desk for a new reader card.",
    "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"
  },
  "id": "a6905826-d84e-4900-a1f8-de1e3829d18d"
}

HTTP status code 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers

Location: required(string)
URI to the created manual-block-template item

Body

Media type: application/json

Type: any

Example:

{
  "name": "Reader card lost",
  "code": "RCL",
  "desc": "Template to use if a patron lost his/her reader card",
  "blockTemplate": {
    "desc": "Reader card lost",
    "patronMessage": "Please contact the library's service desk for a new reader card.",
    "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"
  },
  "id": "a6905826-d84e-4900-a1f8-de1e3829d18d"
}

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 add manual-block-template -- malformed JSON at 13:3"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create manual-block-templates -- unauthorized

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 administrator

/manual-block-templates/{id} get put delete

Entity representing a manual-block-template

get

Get a single manualblock template

put

Update a single manualblock template

delete

Delete a single manualblock template

Get a single manualblock template

Request
Response

URI Parameters

id: 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#",
  "title": "Manual patron block template schema",
  "description": "Allows institution to specify a template for manual patron blocks.",
  "type": "object",
  "properties": {
    "name": {
      "description": "Name of the template",
      "type": "string"
    },
    "code": {
      "description": "Code of the template. Can be a shorthand of the name (e.g. an acronym).",
      "type": "string"
    },
    "desc": {
      "description": "Description of this template",
      "type": "string"
    },
    "blockTemplate": {
      "type": "object",
      "description": "Contains the actual template values",
      "properties": {
        "desc": {
          "description": "Description of the patron block",
          "type": "string"
        },
        "patronMessage": {
          "description": "Message to patron (optional)",
          "type": "string"
        },
        "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"
        }
      }
    },
    "metadata": {
      "description": "Metadata about creation of the patron block template, 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": "Template 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": [
    "name"
  ]
}

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"
}

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"manual-block-template 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

Update a single manualblock template

Request
Response

URI Parameters

id: required(string)

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Manual patron block template schema",
  "description": "Allows institution to specify a template for manual patron blocks.",
  "type": "object",
  "properties": {
    "name": {
      "description": "Name of the template",
      "type": "string"
    },
    "code": {
      "description": "Code of the template. Can be a shorthand of the name (e.g. an acronym).",
      "type": "string"
    },
    "desc": {
      "description": "Description of this template",
      "type": "string"
    },
    "blockTemplate": {
      "type": "object",
      "description": "Contains the actual template values",
      "properties": {
        "desc": {
          "description": "Description of the patron block",
          "type": "string"
        },
        "patronMessage": {
          "description": "Message to patron (optional)",
          "type": "string"
        },
        "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"
        }
      }
    },
    "metadata": {
      "description": "Metadata about creation of the patron block template, 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": "Template 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": [
    "name"
  ]
}

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"
}

HTTP 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 manual-block-template -- malformed JSON at 13:4"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"manual-block-template not found"

HTTP status code 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

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

Delete a single manualblock template

Request
Response

URI Parameters

id: required(string)

HTTP status code 204

Item deleted successfully

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 delete manual-block-template -- constraint violation"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"manual-block-template 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

Templates for Manual Patron Blocks version v1

Manual Patron Block Templates API

/manual-block-templates

Templates for Manual Patron Blocks version v1

Manual Patron Block Templates API

/manual-block-templates

/manual-block-templates get post

get /manual-block-templates

Query Parameters

HTTP status code 200

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 500

Body

post /manual-block-templates

Body

HTTP status code 201

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 422

Body

HTTP status code 500

Body

/manual-block-templates/{id} get put delete

get /manual-block-templates/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

HTTP status code 500

Body

put /manual-block-templates/{id}

URI Parameters

Body

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 409

Body

HTTP status code 500

Body

delete /manual-block-templates/{id}

URI Parameters

HTTP status code 204

HTTP status code 400

Body

HTTP status code 404

Body

HTTP status code 500

Body