API docs by Redocly

Circulation item API (v1)

getCirculationItemsByQuery

Return a list of items based on query

query Parameters
query
string
Default: "cql.allRecords=1"

A query expressed as a CQL string

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 1 .. 2147483647 ]
Default: 1000

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 0,
  • "items": [
    ]
}

createCirculationItem

Add new circulation item

path Parameters
circulationItemId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Request Body schema: application/json
required

Circulation Item object

id
string <uuid>
holdingsRecordId
string <uuid>
object (ItemStatus)

status of the Item

name
string
Enum: "Aged to lost" "Available" "Awaiting delivery" "Awaiting pickup" "Checked out" "Claimed returned" "Declared lost" "Lost and paid" "Long missing" "Missing" "In process" "In process (non-requestable)" "In transit" "Intellectual item" "On order" "Order closed" "Paged" "Restricted" "Unavailable" "Unknown" "Withdrawn"
date
string <date-time>

Date of the current item state. E.g. date set when item state was changed by the Check out app

dcbItem
boolean
materialTypeId
string
permanentLoanTypeId
string
instanceTitle
string
barcode
string
pickupLocation
string
effectiveLocationId
string
lendingLibraryCode
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "holdingsRecordId": "5bb19ab0-f8e0-4e9b-8cb1-923e4cda5161",
  • "status": {
    },
  • "dcbItem": true,
  • "materialTypeId": "string",
  • "permanentLoanTypeId": "string",
  • "instanceTitle": "string",
  • "barcode": "string",
  • "pickupLocation": "string",
  • "effectiveLocationId": "string",
  • "lendingLibraryCode": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "holdingsRecordId": "string",
  • "status": {
    },
  • "materialTypeId": "string",
  • "permanentLoanTypeId": "string",
  • "instanceTitle": "string",
  • "barcode": "string",
  • "pickupLocation": "string",
  • "lendingLibraryCode": "string",
  • "metadata": {
    }
}

retrieveCirculationItemById

Retrieve circulation item

path Parameters
circulationItemId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "holdingsRecordId": "string",
  • "status": {
    },
  • "materialTypeId": "string",
  • "permanentLoanTypeId": "string",
  • "instanceTitle": "string",
  • "barcode": "string",
  • "pickupLocation": "string",
  • "lendingLibraryCode": "string",
  • "metadata": {
    }
}

updateCirculationItem

Change the circulation item

path Parameters
circulationItemId
required
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

Request Body schema: application/json
required
id
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

holdingsRecordId
string (uuid) ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-...

Regexp pattern for UUID validation

object

status

name
string

Enum name of status

date
string <date-time>

Date status

materialTypeId
string

material type id

permanentLoanTypeId
string

permanent loan type id

instanceTitle
string

instance title

barcode
string

item barcode

pickupLocation
string

pickup location

lendingLibraryCode
string

5 digit agency code which identifies the lending library

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "holdingsRecordId": "string",
  • "status": {
    },
  • "materialTypeId": "string",
  • "permanentLoanTypeId": "string",
  • "instanceTitle": "string",
  • "barcode": "string",
  • "pickupLocation": "string",
  • "lendingLibraryCode": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "holdingsRecordId": "string",
  • "status": {
    },
  • "materialTypeId": "string",
  • "permanentLoanTypeId": "string",
  • "instanceTitle": "string",
  • "barcode": "string",
  • "pickupLocation": "string",
  • "lendingLibraryCode": "string",
  • "metadata": {
    }
}