API docs by Redocly

Circulation BFF requests API (v1)

getAllowedServicePoints

Retrieve allowed service points

Retrieve allowed service points

query Parameters
operation
required
string
Enum: "create" "replace"
patronGroupId
string <uuid>
instanceId
string <uuid>
requestId
string <uuid>
requesterId
string <uuid>
itemId
string <uuid>
header Parameters
X-Okapi-Tenant
required
string

The tenant ID for the request

Responses

Response samples

Content type
application/json
{
  • "Page": null,
  • "Hold": null,
  • "Recall": null
}

getInstancesByQuery

Find instances by query and extend with item infor

Find instances by query and extend with item information

query Parameters
query
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "editions": [
    ],
  • "id": "string",
  • "tenantId": "string",
  • "shared": true,
  • "hrid": "string",
  • "source": "string",
  • "statisticalCodeIds": [
    ],
  • "statusId": "string",
  • "title": "string",
  • "indexTitle": "string",
  • "series": [
    ],
  • "alternativeTitles": [
    ],
  • "identifiers": [
    ],
  • "contributors": [
    ],
  • "subjects": [
    ],
  • "dates": {
    },
  • "instanceTypeId": "string",
  • "instanceFormatIds": [
    ],
  • "languages": [
    ],
  • "metadata": {
    },
  • "administrativeNotes": [
    ],
  • "modeOfIssuanceId": "string",
  • "natureOfContentTermIds": [
    ],
  • "publication": [
    ],
  • "staffSuppress": true,
  • "discoverySuppress": true,
  • "isBoundWith": true,
  • "tags": {
    },
  • "classifications": [
    ],
  • "electronicAccess": [
    ],
  • "notes": [
    ],
  • "holdings": [
    ],
  • "physicalDescriptions": [
    ]
}

confirmMediatedRequests

saveAndConfirmMediatedRequest

Confirm mediated request

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

requestLevel
required
string
Enum: "Item" "Title"

Level of the request - Item or Title

requestType
required
string
Enum: "Hold" "Recall" "Page"

Whether the item should be held upon return, recalled or paged for

requestDate
required
string <date-time>

Date when the request was placed

patronComments
string

Comments made by the patron

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Copy of some requester data

firstName
string

First name of the requester

lastName
string

Last name of the requester

middleName
string

Middle name of the requester

barcode
string

Barcode of the requester

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Patron group of the requester

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Copy of some proxy patron data

firstName
string

First name of the proxy patron

lastName
string

Last name of the proxy patron

middleName
string

Middle name of the proxy patron

barcode
string

Barcode of the proxy patron

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Patron group of the proxy patron

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Copy of some instance data

title
required
string

Title of the instance",

required
Array of objects

An extensible set of name-value pairs of identifiers associated with the resource

Array of objects

A list of contributor names

Array of objects

Publication information

editions
Array of strings

The edition statement, imprint and other publication source information

hrid
string

The human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Copy of some item data

barcode
string

Barcode of the item

object

Effective location of the item

enumeration
string

Enumeration of the item

volume
string

Volume of the item

chronology
string

Chronology of the item

displaySummary
string

Display summary of the item

status
string

Status of the item

callNumber
string

Call number of the item

object

Components of the item's call number

copyNumber
string

Copy number of the item

mediatedWorkflow
string

Mediated workflow that mediated request follows

mediatedRequestStatus
string
Enum: "New" "Open" "Closed"

Status of the mediated request

mediatedRequestStep
string

Step of the mediated request in mediated workflow

status
string
Enum: "New - Awaiting confirmation" "Open - Not yet filled" "Open - In transit for approval" "Open - Item arrived" "Open - In transit to be checked out" "Open - Awaiting pickup" "Closed - Cancelled" "Closed - Declined" "Closed - Filled"

Status of the mediated request

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

cancellationAdditionalInformation
string

Additional information about mediated request cancellation

cancelledDate
string <date-time>

Date when the request was cancelled

position
integer

Position of the mediated request in the queue

fulfillmentPreference
required
string
Enum: "Hold Shelf" "Delivery"

How should the request be fulfilled (whether the item should be kept on the hold shelf for collection or delivered to the requester)

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Delivery address

addressTypeId
string

ID of the delivery address type

addressLine1
string

Address line 1

addressLine2
string

Address line 2

city
string

City

region
string

Region

postalCode
string

Postal code

countryId
string

Country ID

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Pickup service point

name
string

Pickup service point name

code
string

Pickup service point code

discoveryDisplayName
string

Pickup service point discovery display name

description
string

Pickup service point description

shelvingLagTime
integer

Pickup service point description

pickupLocation
boolean

Whether pickup service point is a pickup location

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Request fields used for search

object

Effective call number components

shelvingOrder
string

A system generated normalization of the call number that allows for call number sorting in reports and search results

pickupServicePointName
string

The name of the request pickup service point

object (metadata)

Record metadata

createdDate
string

Date and time when the record was created

createdByUserId
string

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 and time when the record was last updated

updatedByUserId
string

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",
  • "requestLevel": "Item",
  • "requestType": "Hold",
  • "requestDate": "2019-08-24T14:15:22Z",
  • "patronComments": "string",
  • "requesterId": "string",
  • "requester": {
    },
  • "proxyUserId": "string",
  • "proxy": {
    },
  • "instanceId": "string",
  • "instance": {
    },
  • "holdingsRecordId": "string",
  • "itemId": "string",
  • "item": {
    },
  • "mediatedWorkflow": "string",
  • "mediatedRequestStatus": "New",
  • "mediatedRequestStep": "string",
  • "status": "New - Awaiting confirmation",
  • "cancellationReasonId": "string",
  • "cancelledByUserId": "string",
  • "cancellationAdditionalInformation": "string",
  • "cancelledDate": "2019-08-24T14:15:22Z",
  • "position": 0,
  • "fulfillmentPreference": "Hold Shelf",
  • "deliveryAddressTypeId": "string",
  • "deliveryAddress": {
    },
  • "pickupServicePointId": "string",
  • "pickupServicePoint": {
    },
  • "confirmedRequestId": "string",
  • "searchIndex": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "requestLevel": "Item",
  • "requestType": "Hold",
  • "requestDate": "2019-08-24T14:15:22Z",
  • "patronComments": "string",
  • "requesterId": "string",
  • "requester": {
    },
  • "proxyUserId": "string",
  • "proxy": {
    },
  • "instanceId": "string",
  • "instance": {
    },
  • "holdingsRecordId": "string",
  • "itemId": "string",
  • "item": {
    },
  • "mediatedWorkflow": "string",
  • "mediatedRequestStatus": "New",
  • "mediatedRequestStep": "string",
  • "status": "New - Awaiting confirmation",
  • "cancellationReasonId": "string",
  • "cancelledByUserId": "string",
  • "cancellationAdditionalInformation": "string",
  • "cancelledDate": "2019-08-24T14:15:22Z",
  • "position": 0,
  • "fulfillmentPreference": "Hold Shelf",
  • "deliveryAddressTypeId": "string",
  • "deliveryAddress": {
    },
  • "pickupServicePointId": "string",
  • "pickupServicePoint": {
    },
  • "confirmedRequestId": "string",
  • "searchIndex": {
    },
  • "metadata": {
    }
}

createRequest

Create ECS TLR or Circulation request

header Parameters
X-Okapi-Tenant
required
string

The tenant ID for the request

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

requestType
required
string
Enum: "Hold" "Recall" "Page"

Whether the item should be held upon return, recalled or paged for

requestLevel
required
string
Enum: "Item" "Title"

Level of the request - Item or Title

requestDate
required
string <date-time>

Date the request was made

patronComments
string

Comments made by the patron

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Copy of some item metadata (used for searching and sorting)

barcode
string

barcode of the item

property name*
additional property
any
object

Copy of some requesting patron metadata (used for searching and sorting), will be taken from the user referred to by the requesterId

firstName
string

first name of the patron (read only, defined by the server)

lastName
string

last name of the patron (read only, defined by the server)

middleName
string

middle name of the patron (read only, defined by the server)

barcode
string

barcode of the patron (read only, defined by the server)

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

patronGroup
string

record for the user's patrongroup

property name*
additional property
any
object

Copy of some proxy patron metadata (used for searching and sorting), will be taken from the user referred to by the proxyUserId

firstName
string

first name of the proxy patron (read only, defined by the server)

lastName
string

last name of the proxy patron (read only, defined by the server)

middleName
string

middle name of the proxy patron (read only, defined by the server)

barcode
string

barcode of the proxy patron (read only, defined by the server)

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

record for the user's patrongroup

fulfillmentPreference
required
string
Enum: "Hold Shelf" "Delivery"

How should the request be fulfilled (whether the item should be kept on the hold shelf for collection or delivered to the requester)

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object

Address the item is to be delivered to (derived from requester information)

addressLine1
string

Address line 1

addressLine2
string

Address line 2

city
string

City name

region
string

Region

postalCode
string

Postal code

countryId
string

Country code

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

requestExpirationDate
string <date-time>

Date when the request expires

holdShelfExpirationDate
string <date-time>

Date when an item returned to the hold shelf expires

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

object (metadata)

Record metadata

createdDate
string

Date and time when the record was created

createdByUserId
string

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 and time when the record was last updated

updatedByUserId
string

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

updatedByUsername
string

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

object

Additional parameters used for request processing and discarded afterwards. Not part of request record.

object (overrideBlocks)

Blocks to override (e.g. during checkout or renewal)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "requestType": "Hold",
  • "requestLevel": "Item",
  • "requestDate": "2019-08-24T14:15:22Z",
  • "patronComments": "string",
  • "requesterId": "string",
  • "proxyUserId": "string",
  • "instanceId": "string",
  • "holdingsRecordId": "string",
  • "itemId": "string",
  • "item": {
    },
  • "requester": {
    },
  • "proxy": {
    },
  • "fulfillmentPreference": "Hold Shelf",
  • "deliveryAddressTypeId": "string",
  • "deliveryAddress": {
    },
  • "requestExpirationDate": "2019-08-24T14:15:22Z",
  • "holdShelfExpirationDate": "2019-08-24T14:15:22Z",
  • "pickupServicePointId": "string",
  • "tags": "string",
  • "metadata": {
    },
  • "requestProcessingParameters": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "requestType": "Hold",
  • "requestLevel": "Item",
  • "ecsRequestPhase": "Primary",
  • "requestDate": "2019-08-24T14:15:22Z",
  • "patronComments": "string",
  • "requesterId": "string",
  • "proxyUserId": "string",
  • "instanceId": "string",
  • "holdingsRecordId": "string",
  • "itemId": "string",
  • "status": "Open - Not yet filled",
  • "cancellationReasonId": "string",
  • "cancelledByUserId": "string",
  • "cancellationAdditionalInformation": "string",
  • "cancelledDate": "2019-08-24T14:15:22Z",
  • "position": 1,
  • "instance": {
    },
  • "item": {
    },
  • "requester": {
    },
  • "proxy": {
    },
  • "fulfillmentPreference": "Hold Shelf",
  • "deliveryAddressTypeId": "string",
  • "deliveryAddress": {
    },
  • "requestExpirationDate": "2019-08-24T14:15:22Z",
  • "holdShelfExpirationDate": "2019-08-24T14:15:22Z",
  • "pickupServicePointId": "string",
  • "pickupServicePoint": {
    },
  • "tags": "string",
  • "metadata": {
    },
  • "requestProcessingParameters": {
    },
  • "searchIndex": {
    }
}

checkInByBarcode

Checks item in by barcode

Request Body schema: application/json
required
itemBarcode
required
string

Item barcode

servicePointId
required
string <uuid>

ID of the service point where item is being checked-in

checkInDate
required
string <date-time>

Date and time of item check-in

claimedReturnedResolution
string

Describes how the library resolved the situation where the item was claimed returned

sessionId
string <uuid>

Randomly generated UUID which must be the same for all check-in requests issued in scope of the same check-in session

Responses

Request samples

Content type
application/json
{
  • "itemBarcode": "string",
  • "servicePointId": "1e4733b3-067d-44f7-9353-ce708a03d0fc",
  • "checkInDate": "2019-08-24T14:15:22Z",
  • "claimedReturnedResolution": "string",
  • "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459"
}

Response samples

Content type
application/json
{
  • "item": {
    },
  • "staffSlipContext": {
    },
  • "loan": {
    }
}

checkOutByBarcode

Checks item out by barcode

Request Body schema: application/json
required
itemBarcode
required
string

Barcode of the item to be lent to the patron

userBarcode
required
string

Barcode of the user (representing the patron) the item is to be lent to

proxyUserBarcode
string

Barcode of the user representing a proxy for the patron

loanDate
string <date-time>

When the loan is to begin, defaults to current date and time

servicePointId
required
string <uuid>

Service point where the item has been checked out

object

Blocks to override

object

'Item not loanable' block

patronBlock
object

Automated patron block

itemLimitBlock
object

Item limit block

renewalBlock
object

Renewal block

object

Override renewal block which requires due date field

comment
string

Reason for override

Responses

Request samples

Content type
application/json
{
  • "itemBarcode": "string",
  • "userBarcode": "string",
  • "proxyUserBarcode": "string",
  • "loanDate": "2019-08-24T14:15:22Z",
  • "servicePointId": "1e4733b3-067d-44f7-9353-ce708a03d0fc",
  • "overrideBlocks": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "borrower": {
    },
  • "proxyUserId": "string",
  • "itemId": "string",
  • "loanPolicyId": "string",
  • "loanPolicy": {
    },
  • "overdueFinePolicyId": "string",
  • "overdueFinePolicy": {
    },
  • "lostItemPolicyId": "string",
  • "lostItemPolicy": {
    },
  • "item": {
    },
  • "loanDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "action": "string",
  • "renewalCount": 0,
  • "feesAndFines": {
    },
  • "metadata": { }
}

getCirculationLoans

findCirculationLoansByQuery

Find circulation loans by query

query Parameters
query
required
string
limit
integer [ 0 .. 2147483647 ]
Default: 10
Example: limit=10

Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see:

offset
integer [ 0 .. 2147483647 ]
Default: 0
Example: offset=0

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

totalRecords
stringexact|estimated|none|auto
Default: "auto"

How to calculate the totalRecords property.

Responses

Response samples

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

getCirculationLoanById

getCirculationLoanById

Retrieve circulation flow by id

path Parameters
loanId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "borrower": {
    },
  • "proxyUserId": "string",
  • "itemId": "string",
  • "loanPolicyId": "string",
  • "loanPolicy": {
    },
  • "overdueFinePolicyId": "string",
  • "overdueFinePolicy": {
    },
  • "lostItemPolicyId": "string",
  • "lostItemPolicy": {
    },
  • "item": {
    },
  • "itemEffectiveLocationIdAtCheckOut": "string",
  • "status": {
    },
  • "loanDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "returnDate": "2019-08-24T14:15:22Z",
  • "systemReturnDate": "2019-08-24T14:15:22Z",
  • "action": "string",
  • "actionComment": "string",
  • "renewalCount": 0,
  • "dueDateChangedByRecall": true,
  • "dueDateChangedByNearExpireUser": true,
  • "dueDateChangedByHold": true,
  • "checkoutServicePointId": "string",
  • "checkinServicePointId": "string",
  • "checkoutServicePoint": {
    },
  • "checkinServicePoint": {
    },
  • "patronGroupAtCheckout": {
    },
  • "feesAndFines": {
    },
  • "declaredLostDate": "2019-08-24T14:15:22Z",
  • "isDcb": true,
  • "metadata": {
    }
}

getExternalUsers

getExternalUsers

Find users by externalSystemId in the specified tenant

path Parameters
externalUserId
required
string
tenantId
required
string

Responses

Response samples

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

getPickSlips

getPickSlips

API to get pick slips

path Parameters
servicePointId
required
string

Responses

Response samples

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

getSearchSlips

getSearchSlips

API to get search slips

path Parameters
servicePointId
required
string

Responses

Response samples

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

ecsRequestExternal

postEcsRequestExternal

Create ECS request external

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

requestLevel
required
string
Enum: "Item" "Title"

Level of the request - Item or Title

requestExpirationDate
string <date-time>

Date when the request expires

requestDate
required
string <date-time>

Date when the request was placed

patronComments
string

Comments made by the patron

fulfillmentPreference
required
string
Enum: "Hold Shelf" "Delivery"

How should the request be fulfilled (whether the item should be kept on the hold shelf for collection or delivered to the requester)

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

primaryRequestTenantId
string

ID of the tenant primary request was created in

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

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

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

secondaryRequestTenantId
string

ID of the tenant secondary request was created in

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "instanceId": "string",
  • "requesterId": "string",
  • "requestLevel": "Item",
  • "requestExpirationDate": "2019-08-24T14:15:22Z",
  • "requestDate": "2019-08-24T14:15:22Z",
  • "patronComments": "string",
  • "fulfillmentPreference": "Hold Shelf",
  • "pickupServicePointId": "string",
  • "itemId": "string",
  • "holdingsRecordId": "string",
  • "primaryRequestId": "string",
  • "primaryRequestDcbTransactionId": "string",
  • "primaryRequestTenantId": "string",
  • "secondaryRequestId": "string",
  • "secondaryRequestDcbTransactionId": "string",
  • "secondaryRequestTenantId": "string"
}

Response samples

Content type
application/json
Example
{
  • "id": "string",
  • "requestLevel": "Item",
  • "requestType": "Hold",
  • "requestDate": "2019-08-24T14:15:22Z",
  • "patronComments": "string",
  • "requesterId": "string",
  • "requester": {
    },
  • "proxyUserId": "string",
  • "proxy": {
    },
  • "instanceId": "string",
  • "instance": {
    },
  • "holdingsRecordId": "string",
  • "itemId": "string",
  • "item": {
    },
  • "mediatedWorkflow": "string",
  • "mediatedRequestStatus": "New",
  • "mediatedRequestStep": "string",
  • "status": "New - Awaiting confirmation",
  • "cancellationReasonId": "string",
  • "cancelledByUserId": "string",
  • "cancellationAdditionalInformation": "string",
  • "cancelledDate": "2019-08-24T14:15:22Z",
  • "position": 0,
  • "fulfillmentPreference": "Hold Shelf",
  • "deliveryAddressTypeId": "string",
  • "deliveryAddress": {
    },
  • "pickupServicePointId": "string",
  • "pickupServicePoint": {
    },
  • "confirmedRequestId": "string",
  • "searchIndex": {
    },
  • "metadata": {
    }
}

declareItemLost

declareItemLost

Declares item lost

path Parameters
loanId
required
string <uuid>

The ID of the loan

Request Body schema: application/json
required
declaredLostDateTime
required
string <date-time>

The date and time when the item is to be declared lost

comment
string

Comment explaining why the item has been declared lost

servicePointId
required
string <uuid>

Current service point, where the item is being declared lost

Responses

Request samples

Content type
application/json
{
  • "declaredLostDateTime": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "servicePointId": "1e4733b3-067d-44f7-9353-ce708a03d0fc"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 1
}

claimItemReturned

claimItemReturned

Claims item returned

path Parameters
loanId
required
string <uuid>

The ID of the loan

Request Body schema: application/json
required
itemClaimedReturnedDateTime
required
string <date-time>

The date and time when the item is to be claimed returned

comment
string

Comment explaining why the item has been claimed returned

Responses

Request samples

Content type
application/json
{
  • "itemClaimedReturnedDateTime": "2019-08-24T14:15:22Z",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 1
}