Patron Block Limits (v0.1)

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

Table of contents

mod-users Patron Block Limits API

This documents the API calls that can be made to query and manage patron block limits

/patron-block-limits

Collection of patron-block-limit items.

GET /patron-block-limits

Return a list of patron block limits

GET /patron-block-limits
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-limit items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of available patron block limits",
  "type": "object",
  "properties": {
    "patronBlockLimits": {
      "description": "List of available patron block limits",
      "id": "patronBlockLimits",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "patron-block-limit.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "patronBlockLimits",
    "totalRecords"
  ]
}

Example:

{
  "patronBlockLimits": [
    {
      "id": "1de95200-72e4-4967-bdf8-257fb7559536",
      "patronGroupId": "ac502f9e-a611-4644-8a8c-a5bb9768a7f6",
      "conditionId": "72b67965-5b73-4840-bc0b-be8f3f6e047e",
      "value": "10"
    },
    {
      "id": "d3106d61-1867-47e0-84b9-5a21f1928ebd",
      "patronGroupId": "72b67965-5b73-4840-bc0b-be8f3f6e047e",
      "conditionId": "584fbd4f-6a34-4730-a6ca-73a6a6a9d845",
      "value": "10"
    }
  ],
  "totalRecords": 2
}

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-limits -- 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-limits -- 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-limits

Create a patron block limit

POST /patron-block-limits
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 limits schema",
  "properties": {
    "id": {
      "type": "string",
      "description": "A UUID identifying the limit",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "patronGroupId": {
      "type": "string",
      "description": "A UUID identifying the patron group",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "conditionId": {
      "type": "string",
      "description": "A UUID identifying the condition",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "value": {
      "type": "number",
      "description": "Limit value"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "id",
    "patronGroupId",
    "conditionId",
    "value"
  ]
}

Example:

{
  "id": "1de95200-72e4-4967-bdf8-257fb7559536",
  "patronGroupId": "ac502f9e-a611-4644-8a8c-a5bb9768a7f6",
  "conditionId": "72b67965-5b73-4840-bc0b-be8f3f6e047e",
  "value": "10"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created patron-block-limit item

Body

Media type: application/json

Type: any

Example:

{
  "id": "1de95200-72e4-4967-bdf8-257fb7559536",
  "patronGroupId": "ac502f9e-a611-4644-8a8c-a5bb9768a7f6",
  "conditionId": "72b67965-5b73-4840-bc0b-be8f3f6e047e",
  "value": "10"
}

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-limit -- 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-limits -- 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-limits/{patronBlockLimitId}

Update a patron block limit

PUT /patron-block-limits/{patronBlockLimitId}
URI Parameters
  • patronBlockLimitId: 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 limits schema",
  "properties": {
    "id": {
      "type": "string",
      "description": "A UUID identifying the limit",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "patronGroupId": {
      "type": "string",
      "description": "A UUID identifying the patron group",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "conditionId": {
      "type": "string",
      "description": "A UUID identifying the condition",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "value": {
      "type": "number",
      "description": "Limit value"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "id",
    "patronGroupId",
    "conditionId",
    "value"
  ]
}

Example:

{
  "id": "1de95200-72e4-4967-bdf8-257fb7559536",
  "patronGroupId": "ac502f9e-a611-4644-8a8c-a5bb9768a7f6",
  "conditionId": "72b67965-5b73-4840-bc0b-be8f3f6e047e",
  "value": "10"
}

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-limit -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"patron-block-limit 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-limits/{patronBlockLimitId}

Retrieve patron-block-limit item with given {patron-block-limitId}

GET /patron-block-limits/{patronBlockLimitId}
URI Parameters
  • patronBlockLimitId: 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 limits schema",
  "properties": {
    "id": {
      "type": "string",
      "description": "A UUID identifying the limit",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "patronGroupId": {
      "type": "string",
      "description": "A UUID identifying the patron group",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "conditionId": {
      "type": "string",
      "description": "A UUID identifying the condition",
      "$ref": "raml-util/schemas/uuid.schema"
    },
    "value": {
      "type": "number",
      "description": "Limit value"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "id",
    "patronGroupId",
    "conditionId",
    "value"
  ]
}

Example:

{
  "id": "1de95200-72e4-4967-bdf8-257fb7559536",
  "patronGroupId": "ac502f9e-a611-4644-8a8c-a5bb9768a7f6",
  "conditionId": "72b67965-5b73-4840-bc0b-be8f3f6e047e",
  "value": "10"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"patron-block-limit 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-limits/{patronBlockLimitId}

Delete patron-block-limit item with given {patron-block-limitId}

DELETE /patron-block-limits/{patronBlockLimitId}
URI Parameters
  • patronBlockLimitId: 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-limit -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"patron-block-limit 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