Cancellation Reasons (v1.1)

http://localhost:9130

Table of contents

Cancellation Reasons API

Storage for cancellation reasons

/cancellation-reason-storage

GET /cancellation-reason-storage/cancellation-reasons

Retrieve a list of cancellation-reason items.

GET /cancellation-reason-storage/cancellation-reasons
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.

    with valid searchable fields

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    cancellationReason=lost
    
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of cancellation-reason items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of cancellation reasons",
  "type": "object",
  "properties": {
    "cancellationReasons": {
      "description": "List of items",
      "id": "cancellationReasons",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "cancellation-reason.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "cancellationReasons",
    "totalRecords"
  ]
}

Example:

{
  "cancellationReasons" : [
    {
      "id": "5aace7aa-a741-4d69-9741-46737da78f7f",
      "name": "Not available",
      "description": "The item is no longer available",
      "publicDescription": "The item status is unknown",
      "requiresAdditionalInformation": false
        }
  ],
  "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 cancellation-reasons -- 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 cancellation-reasons -- 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

Response 501

Not implemented yet

POST /cancellation-reason-storage/cancellation-reasons

Create a new cancellation-reason item.

POST /cancellation-reason-storage/cancellation-reasons
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",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description" : {
      "type": "string"
    },
    "publicDescription": {
      "type": "string"
    },
    "requiresAdditionalInformation": {
      "type": "boolean"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
   },
   "additionalProperties": false,
    "required": [
      "name"
    ]
}


Example:

{
  "id": "5aace7aa-a741-4d69-9741-46737da78f7f",
  "name": "Not available",
  "description": "The item is no longer available",
  "publicDescription": "The item status is unknown",
  "requiresAdditionalInformation": false
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created cancellation-reason item

Body

Media type: application/json

Type: any

Example:

{
  "id": "5aace7aa-a741-4d69-9741-46737da78f7f",
  "name": "Not available",
  "description": "The item is no longer available",
  "publicDescription": "The item status is unknown",
  "requiresAdditionalInformation": false
}

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create cancellation-reasons -- 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

Response 501

Not implemented yet

DELETE /cancellation-reason-storage/cancellation-reasons

DELETE /cancellation-reason-storage/cancellation-reasons
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

All cancellation reasons deleted

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

Response 501

Not implemented yet

GET /cancellation-reason-storage/cancellation-reasons/{cancellationReasonId}

Retrieve cancellation-reason item with given {cancellation-reasonId}

GET /cancellation-reason-storage/cancellation-reasons/{cancellationReasonId}
URI Parameters
  • cancellationReasonId: 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",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description" : {
      "type": "string"
    },
    "publicDescription": {
      "type": "string"
    },
    "requiresAdditionalInformation": {
      "type": "boolean"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
   },
   "additionalProperties": false,
    "required": [
      "name"
    ]
}


Example:

{
  "id": "5aace7aa-a741-4d69-9741-46737da78f7f",
  "name": "Not available",
  "description": "The item is no longer available",
  "publicDescription": "The item status is unknown",
  "requiresAdditionalInformation": false
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"cancellation-reason 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

Response 501

Not implemented yet

PUT /cancellation-reason-storage/cancellation-reasons/{cancellationReasonId}

Update cancellation-reason item with given {cancellation-reasonId}

PUT /cancellation-reason-storage/cancellation-reasons/{cancellationReasonId}
URI Parameters
  • cancellationReasonId: 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",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description" : {
      "type": "string"
    },
    "publicDescription": {
      "type": "string"
    },
    "requiresAdditionalInformation": {
      "type": "boolean"
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
   },
   "additionalProperties": false,
    "required": [
      "name"
    ]
}


Example:

{
  "id": "5aace7aa-a741-4d69-9741-46737da78f7f",
  "name": "Not available",
  "description": "The item is no longer available",
  "publicDescription": "The item status is unknown",
  "requiresAdditionalInformation": false
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"cancellation-reason 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

Response 501

Not implemented yet

DELETE /cancellation-reason-storage/cancellation-reasons/{cancellationReasonId}

Delete cancellation-reason item with given {cancellation-reasonId}

DELETE /cancellation-reason-storage/cancellation-reasons/{cancellationReasonId}
URI Parameters
  • cancellationReasonId: 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 cancellation-reason -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"cancellation-reason 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

Response 501

Not implemented yet