Circulation (v0.2)

http://localhost:9130

Table of contents

Circulation Business Logic API

API for moving request from one Item to another

/circulation

POST /circulation/requests/{requestId}/move

Move Request to specified Item

POST /circulation/requests/{requestId}/move
URI Parameters
  • requestId: required (string)
Body

Media type: application/json

Type:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Request to move a request from one item to another",
  "properties": {
    "destinationItemId": {
      "description": "UUID of the item the request should be moved to",
      "type": "string"
    },
    "requestType": {
      "description": "Whether the item should be held upon return, recalled or paged for",
      "type": "string",
      "enum": ["Hold", "Recall", "Page"]
    }
  },
  "additionalProperties": false,
  "required": [
    "destinationItemId"
  ]
}

Example:

{
  "destinationItemId": "51763f82-c8e6-4486-9fdc-1c1664352550"
}

Response 200

Request has been moved

Body

Media type: application/json

Type:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "A request for an item",
  "description": "Request for an item that might be at a different location or already checked out to another patron",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of the request",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "requestType": {
      "description": "Whether the item should be held upon return, recalled or paged for",
      "type": "string",
      "enum": ["Hold", "Recall", "Page"]
    },
    "requestDate": {
      "description": "Date the request was made",
      "type": "string",
      "format": "date-time"
    },
    "requesterId": {
      "description": "ID of the user who made the request",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "proxyUserId": {
      "description": "ID of the user representing a proxy for the patron",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "itemId": {
      "description": "ID of the item being requested",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "status": {
      "description": "Status of the request",
      "type": "string",
      "enum": [
        "Open - Not yet filled",
        "Open - Awaiting pickup",
        "Open - In transit",
        "Closed - Filled",
        "Closed - Cancelled",
        "Closed - Unfilled",
        "Closed - Pickup expired"
      ]
    },
    "cancellationReasonId": {
      "description": "The id of the request reason",
      "type": "string"
    },
    "cancelledByUserId": {
      "description": "The id of the user that cancelled the request",
      "type": "string"
    },
    "cancellationAdditionalInformation": {
      "description": "Additional information about a cancellation",
      "type": "string"
    },
    "cancelledDate": {
      "description": "Date the request was cancelled",
      "type": "string",
      "format": "date-time"
    },
    "position": {
      "description": "position of the request in a per-item request queue",
      "type": "integer"
    },
    "item": {
      "description": "Information about the requested item (some of which is stored and used for searching and sorting)",
      "readOnly": true,
      "type": "object",
      "properties": {
        "title": {
          "description": "title of the item (stored)",
          "type": "string",
          "readonly": true
        },
        "barcode": {
          "description": "barcode of the item (stored)",
          "type": "string",
          "readonly": true
        },
        "holdingsRecordId": {
          "description": "The ID of the holdings for the item",
          "type": "string",
          "readonly": true
        },
        "instanceId": {
          "description": "The ID of the instance for the item",
          "type": "string",
          "readonly": true
        },
        "location": {
          "description": "The effective location of the item",
          "type": "object",
          "readonly": true,
          "additionalProperties": false,
          "properties": {
            "name": {
              "type": "string",
              "description": "The name of the location",
              "readonly": true
            },
            "libraryName": {
              "type": "string",
              "description": "The name of the library of the location",
              "readonly": true
            },
            "code": {
              "type": "string",
              "description": "The location code",
              "readonly": true
            }
          }
        },
        "contributorNames": {
          "description": "A list of contributor names",
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "name": {
                "description": "The contributor name",
                "type": "string"
              }
            }
          }
        },
        "copyNumbers": {
          "type": "array",
          "description": "Copy numbers for the item",
          "items": {
            "type": "string"
          }
        },
        "enumeration": {
          "description": "The volume and/or issue number for the item",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "requester": {
      "description": "Copy of some requesting patron metadata (used for searching and sorting), will be taken from the user referred to by the requesterId",
      "readonly": true,
      "type": "object",
      "properties": {
        "firstName": {
          "description": "first name of the patron (read only, defined by the server)",
          "type": "string",
          "readonly": true
        },
        "lastName": {
          "description": "last name of the patron (read only, defined by the server)",
          "type": "string",
          "readonly": true
        },
        "middleName": {
          "description": "middle name of the patron (read only, defined by the server)",
          "type": "string",
          "readonly": true
        },
        "barcode": {
          "description": "barcode of the patron (read only, defined by the server)",
          "type": "string",
          "readonly": true
        },
        "patronGroupId": {
          "description": "UUID for the patron group that this user belongs to",
          "type": "string"
        },
        "patronGroup": {
          "description": "record for the user's patron group",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "id": {
              "description": "ID of the patron group",
              "type": "string"
            },
            "group": {
              "description": "The unique name of the patron group",
              "type": "string"
            },
            "desc": {
              "description": "A description of the patron group",
              "type": "string"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "proxy": {
      "description": "Copy of some proxy patron metadata (used for searching and sorting), will be taken from the user referred to by the proxyUserId",
      "readonly": true,
      "type": "object",
      "properties": {
        "firstName": {
          "description": "first name of the proxy patron (read only, defined by the server)",
          "type": "string",
          "readonly": true
        },
        "lastName": {
          "description": "last name of the proxy patron (read only, defined by the server)",
          "type": "string",
          "readonly": true
        },
        "middleName": {
          "description": "middle name of the proxy patron (read only, defined by the server)",
          "type": "string",
          "readonly": true
        },
        "barcode": {
          "description": "barcode of the proxy patron (read only, defined by the server)",
          "type": "string",
          "readonly": true
        },
        "patronGroupId": {
          "description": "UUID for the patrongroup that this user belongs to",
          "type": "string"
        },
        "patronGroup": {
          "description": "record for the user's patrongroup",
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "id": {
              "description": "ID of the patrongroup",
              "type": "string"
            },
            "group": {
              "description": "The unique name of the patrongroup",
              "type": "string"
            },
            "desc": {
              "description": "A description of the patrongroup",
              "type": "string"
            }
          }
        }
      },
      "additionalProperties": false
    },
    "fulfilmentPreference": {
      "description": "How should the request be fulfilled (whether the item should be kept on the hold shelf for collection or delivered to the requester)",
      "type": "string",
      "enum": ["Hold Shelf", "Delivery"]
    },
    "deliveryAddressTypeId": {
      "description": "Deliver to the address of this type, for the requesting patron",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "deliveryAddress": {
      "description": "Address the item is to be delivered to (derived from requester information)",
      "type": "object",
      "properties": {
        "addressLine1": {
          "description": "Address line 1",
          "type": "string"
        },
        "addressLine2": {
          "description": "Address line 2",
          "type": "string"
        },
        "city": {
          "description": "City name",
          "type": "string"
        },
        "region": {
          "description": "Region",
          "type": "string"
        },
        "postalCode": {
          "description": "Postal code",
          "type": "string"
        },
        "countryId": {
          "description": "Country code",
          "type": "string"
        },
        "addressTypeId": {
          "description": "Type of address (refers to address types)",
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "requestExpirationDate": {
      "description": "Date when the request expires",
      "type": "string",
      "format": "date-time"
    },
    "holdShelfExpirationDate": {
      "description": "Date when an item returned to the hold shelf expires",
      "type": "string",
      "format": "date-time"
    },
    "pickupServicePointId": {
      "description": "The ID of the Service Point where this request can be picked up",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "pickupServicePoint": {
      "description": "The full object of the Service Point record from pickupServicePointId",
      "additionalProperties": false,
      "properties": {
        "name": {
          "description": "Unique name for the service point",
          "type": "string"
        },
        "code": {
          "description": "Unique code for the service point",
          "type": "string"
        },
        "discoveryDisplayName": {
          "description": "Human-readable name for the service point",
          "type": "string"
        },
        "description": {
          "description": "Description of the service point",
          "type": "string"
        },
        "shelvingLagTime": {
          "description": "Shelving lag time",
          "type": "integer"
        },
        "pickupLocation": {
          "description": "Is this service point a pickup location?",
          "type": "boolean"
        }
      }
    },
    "tags": {
      "type": "object",
      "description": "Tags",
      "$ref": "raml-util/schemas/tags.schema"
    },
    "metadata": {
      "description": "Metadata about creation and changes to requests, provided by the server (client should not provide)",
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema"
    }
  },
  "additionalProperties": false,
  "required": [
    "itemId",
    "requesterId",
    "requestType",
    "requestDate",
    "fulfilmentPreference"
  ]
}

Example:

{
  "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",
  "requestExpirationDate": "2017-07-25T22:25:37Z",
  "position": 1,
  "item": {
    "title": "Children of Time",
    "barcode": "760932543816",
    "location": {
      "name": "Main Library"
    },
    "copyNumbers": [
      "1",
      "2"
    ]
  },
  "tags": {
    "tagList": [
      "new",
      "important"
    ]
  }
}

Response 404

Request record not found

Body

Media type: text/plain

Type: any

Example:

request record with ID "f3eb6d07-861a-4b76-9937-2ae12768e5f5" cannot be found

Response 422

Unable to process request

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": "Item does not exist",
      "parameters": [
        {
          "key": "itemId",
          "value": "91719676-e7b5-4f83-bdab-cb70dd10c1e3"
        }
      ]
    }
  ]
}

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error