Patron Block Conditions (v0.1)

http://github.com/org/folio/mod-users

Table of contents

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

Collection of patron-block-condition items.

GET /patron-block-conditions

Return a list of patron block conditions

GET /patron-block-conditions
Query Parameters
  • 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

    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*"
    
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of patron-block-condition items

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",
        "$ref": "patron-block-condition.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "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
}

Response 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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list patron-block-conditions -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /patron-block-conditions

Create a patron block condition

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

    Requested language. Optional. [lang=en]

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",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "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)",
      "$ref": "raml-util/schemas/metadata.schema"
    }
  },
  "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"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created patron-block-condition item

Body

Media type: application/json

Type: any

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

Response 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 patron-block-condition -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create patron-block-conditions -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /patron-block-conditions/{patronBlockConditionId}

Update a patron block condition

PUT /patron-block-conditions/{patronBlockConditionId}
URI Parameters
  • patronBlockConditionId: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

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",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "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)",
      "$ref": "raml-util/schemas/metadata.schema"
    }
  },
  "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"
}

Response 204

Item successfully updated

Response 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 patron-block-condition -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"patron-block-condition not found"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

GET /patron-block-conditions/{patronBlockConditionId}

Retrieve patron-block-condition item with given {patron-block-conditionId}

GET /patron-block-conditions/{patronBlockConditionId}
URI Parameters
  • patronBlockConditionId: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 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",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "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)",
      "$ref": "raml-util/schemas/metadata.schema"
    }
  },
  "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"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"patron-block-condition not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /patron-block-conditions/{patronBlockConditionId}

Delete patron-block-condition item with given {patron-block-conditionId}

DELETE /patron-block-conditions/{patronBlockConditionId}
URI Parameters
  • patronBlockConditionId: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 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 patron-block-condition -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"patron-block-condition not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator