Circulation API documentation version v0.2

http://localhost:9130

Circulation Business Logic API

API for report generation

/circulation

get

Entity representing a hold-shelf-clearance

get

Retrieve hold-shelf-clearance item with given {hold-shelf-clearanceId}

Retrieve hold-shelf-clearance item with given {hold-shelf-clearanceId}

URI Parameters

  • servicePointId: required (string)

Query Parameters

  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

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": "Collection of item requests",
  "description": "Collection of item requests",
  "type": "object",
  "properties": {
    "requests": {
      "description": "Paged collection of item requests",
      "id": "requests",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "request.json"
      }
    },
    "totalRecords": {
      "description": "Total number of item requests",
      "type": "integer"
    }
  },
  "required": [
    "requests",
    "totalRecords"
  ]
}

Example:

{
  "requests": [
    {
      "id": "89105c06-dbdb-4aa0-9695-d4d19c733270",
      "requestType": "Recall",
      "requestDate": "2017-07-29T22:25:37Z",
      "requesterId": "21932a85-bd00-446b-9565-46e0c1a5490b",
      "itemId": "195efae1-588f-47bd-a181-13a2eb437701",
      "fulfilmentPreference": "Hold Shelf",
      "position": 1
    },
    {
      "id": "f5cec279-0da6-4b44-a3df-f49b0903f325",
      "requestType": "Hold",
      "requestDate": "2017-08-05T11:43:23Z",
      "requesterId": "61d939e4-f2ae-4c53-95d2-224a802fa2a6",
      "itemId": "3e5d5433-a271-499c-94f4-5f3e4652e537",
      "fulfilmentPreference": "Delivery",
      "requestExpirationDate": "2017-08-31T22:25:37Z",
      "holdShelfExpirationDate": "2017-09-01T22:25:37Z",
      "position": 1,
      "item": {
        "title": "Children of Time",
        "barcode": "760932543816",
        "copyNumbers": [
          "1",
          "2"
        ]
      },
      "requester": {
        "firstName": "Stephen",
        "lastName": "Jones",
        "middleName": "Anthony",
        "barcode": "567023127436"
      },
      "tags": {
        "tagList": [
          "new",
          "important"
        ]
      }
    }
  ],
  "totalRecords": 2
}

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 hold-shelf-clearance -- 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 hold-shelf-clearance -- unauthorized"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"hold-shelf-clearance 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