Manual Patron Blocks (v1)

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

Table of contents

Manual Patron Blocks API

This documents the API calls that can be made to query and manage manualblock of the system

/manualblocks

Collection of manualblock items.

GET /manualblocks

Return a list of manualblocks

GET /manualblocks
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

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

    Requested language. Optional. [lang=en]

Response 200

Returns a list of manualblock items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "manualblocks": {
      "type": "array",
      "id": "manualblocksData",
      "items": {
        "type": "object",
        "$ref": "manualblockdata.json"
      }
    },
    "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
}

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 manualblocks -- 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 manualblocks -- 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 /manualblocks

Create a manualblock

POST /manualblocks
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#",
  "title": "Manual Patron Block Schema",
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "desc": {
      "type": "string"
    },
    "staffInformation": {
      "type": "string"
    },
    "patronMessage": {
      "type": "string"
    },
    "expirationDate": {
      "type": "string",
      "format": "date-time"
    },
    "borrowing": {
      "type": "boolean"
    },
    "renewals": {
      "type": "boolean"
    },
    "requests": {
      "type": "boolean"
    },
    "userId": {
      "type": "string"
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "desc",
    "userId",
    "id"
   ]
}

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

Response 201

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

Headers
  • Location: required (string)

    URI to the created manualblock item

Body

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

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 manualblock -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create manualblocks -- 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": {
      "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 /manualblocks/{manualblockId}

Get a single manualblock

GET /manualblocks/{manualblockId}
URI Parameters
  • manualblockId: 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#",
  "title": "Manual Patron Block Schema",
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "desc": {
      "type": "string"
    },
    "staffInformation": {
      "type": "string"
    },
    "patronMessage": {
      "type": "string"
    },
    "expirationDate": {
      "type": "string",
      "format": "date-time"
    },
    "borrowing": {
      "type": "boolean"
    },
    "renewals": {
      "type": "boolean"
    },
    "requests": {
      "type": "boolean"
    },
    "userId": {
      "type": "string"
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "desc",
    "userId",
    "id"
   ]
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"manualblock 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 /manualblocks/{manualblockId}

Delete manualblock item with given {manualblockId}

DELETE /manualblocks/{manualblockId}
URI Parameters
  • manualblockId: 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 manualblock -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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

PUT /manualblocks/{manualblockId}

Update manualblock item with given {manualblockId}

PUT /manualblocks/{manualblockId}
URI Parameters
  • manualblockId: 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#",
  "title": "Manual Patron Block Schema",
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "desc": {
      "type": "string"
    },
    "staffInformation": {
      "type": "string"
    },
    "patronMessage": {
      "type": "string"
    },
    "expirationDate": {
      "type": "string",
      "format": "date-time"
    },
    "borrowing": {
      "type": "boolean"
    },
    "renewals": {
      "type": "boolean"
    },
    "requests": {
      "type": "boolean"
    },
    "userId": {
      "type": "string"
    },
    "metadata" : {
      "type" : "object",
      "$ref" : "raml-util/schemas/metadata.schema"
    },
    "id": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "desc",
    "userId",
    "id"
   ]
}

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

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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