API docs by Redocly

Request Mediated API (v1)

requestsMediated

requestsMediatedActions

mediatedRequestsCrud

postMediatedRequest

Create 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
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" "Open - Awaiting delivery" "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
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 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",
  • "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": "69abbd7d-b4a6-4376-8453-bf349c579a91",
  • "requestLevel": "Title",
  • "requestType": "Hold",
  • "requestDate": "2024-01-01T00:12:00Z",
  • "patronComments": "",
  • "requesterId": "73b17dee-d278-4128-b0fd-5d9f801b0400",
  • "requester": {
    },
  • "proxyUserId": "13e309c8-d501-4c3b-9cbc-d573621bb62c",
  • "proxy": {
    },
  • "instanceId": "6d996a75-930d-4ad1-a953-9b44c9021a35",
  • "instance": {
    },
  • "holdingsRecordId": null,
  • "itemId": null,
  • "item": {
    },
  • "mediatedWorkflow": "Private request",
  • "mediatedRequestStatus": "New",
  • "status": "New - Awaiting confirmation",
  • "cancellationReasonId": null,
  • "cancelledByUserId": null,
  • "cancellationAdditionalInformation": null,
  • "cancelledDate": null,
  • "position": 1,
  • "fulfillmentPreference": "Hold Shelf",
  • "deliveryAddressTypeId": null,
  • "pickupServicePointId": "b2ffa7df-98e8-48a1-b5a8-4e712364eb8d",
  • "pickupServicePoint": {
    },
  • "confirmedRequestId": "0a034628-6eb6-4c66-9ea5-9eeea151c820",
  • "searchIndex": {
    }
}

getMediatedRequestCollection

Retrieve a collection of mediated requests

query Parameters
query
string

A query string to filter rules based on matching criteria in fields.

offset
integer [ 0 .. 2147483647 ]
Default: 0

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

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "mediatedRequests": [
    ],
  • "totalRecords": 1
}

getMediatedRequestById

Retrieve mediated request object by id

path Parameters
mediatedRequestId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "69abbd7d-b4a6-4376-8453-bf349c579a91",
  • "requestLevel": "Title",
  • "requestType": "Hold",
  • "requestDate": "2024-01-01T00:12:00Z",
  • "patronComments": "",
  • "requesterId": "73b17dee-d278-4128-b0fd-5d9f801b0400",
  • "requester": {
    },
  • "proxyUserId": "13e309c8-d501-4c3b-9cbc-d573621bb62c",
  • "proxy": {
    },
  • "instanceId": "6d996a75-930d-4ad1-a953-9b44c9021a35",
  • "instance": {
    },
  • "holdingsRecordId": null,
  • "itemId": null,
  • "item": {
    },
  • "mediatedWorkflow": "Private request",
  • "mediatedRequestStatus": "New",
  • "status": "New - Awaiting confirmation",
  • "cancellationReasonId": null,
  • "cancelledByUserId": null,
  • "cancellationAdditionalInformation": null,
  • "cancelledDate": null,
  • "position": 1,
  • "fulfillmentPreference": "Hold Shelf",
  • "deliveryAddressTypeId": null,
  • "pickupServicePointId": "b2ffa7df-98e8-48a1-b5a8-4e712364eb8d",
  • "pickupServicePoint": {
    },
  • "confirmedRequestId": "0a034628-6eb6-4c66-9ea5-9eeea151c820",
  • "searchIndex": {
    }
}

putMediatedRequestById

Update mediated request by ID

path Parameters
mediatedRequestId
required
string <uuid>
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
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" "Open - Awaiting delivery" "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
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 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",
  • "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
{
  • "errors": [
    ],
  • "total_records": 1
}

deleteMediatedRequestById

Remove mediated request by ID

path Parameters
mediatedRequestId
required
string <uuid>

Responses

Response samples

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

mediatedRequestsActions

confirmMediatedRequest

Confirm mediated request

path Parameters
mediatedRequestId
required
string <uuid>

Responses

Response samples

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

declineMediatedRequest

Decline mediated request

path Parameters
mediatedRequestId
required
string <uuid>

Responses

Response samples

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

confirmItemArrival

Confirm item arrival

Request Body schema: application/json
required
itemBarcode
required
string

Barcode of the confirmed item

Responses

Request samples

Content type
application/json
{
  • "itemBarcode": "string"
}

Response samples

Content type
application/json
{
  • "arrivalDate": "2024-08-22T13:03:12.440Z",
  • "instance": {
    },
  • "item": {
    },
  • "mediatedRequest": {
    },
  • "requester": {
    }
}

sendItemInTransit

Send item in transit

Request Body schema: application/json
required
itemBarcode
required
string

Barcode of the sent item in transit

Responses

Request samples

Content type
application/json
{
  • "itemBarcode": "string"
}

Response samples

Content type
application/json
{
  • "inTransitDate": "2024-08-22T13:03:12.440Z",
  • "instance": {
    },
  • "item": {
    },
  • "mediatedRequest": {
    },
  • "requester": {
    }
}

mediatedRequestsLoans

checkOutByBarcode

Check out an item for secure request

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

forceLoanPolicyId
string <uuid>

Force loan policy ID

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",
  • "forceLoanPolicyId": "3ff1a78c-ba8a-4944-b13b-6d94dca8c27a",
  • "overrideBlocks": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d16f0c36-7105-4a46-98e8-736d0e3e7d3e",
  • "userId": "2205005b-ca51-4a04-87fd-938eefa8f6de",
  • "borrower": {
    },
  • "itemId": "7212ba6a-8dcf-45a1-be9a-ffaa847c4423",
  • "loanPolicyId": "43198de5-f56a-4a53-a0bd-5a324418967a",
  • "loanPolicy": {
    },
  • "overdueFinePolicyId": "cd3f6cac-fa17-4079-9fae-2fb28e521412",
  • "overdueFinePolicy": {
    },
  • "lostItemPolicyId": "ed892c0e-52e0-4cd9-8133-c0ef07b4a709",
  • "lostItemPolicy": {
    },
  • "item": {
    },
  • "loanDate": "2025-05-16T09:15:48.769+00:00",
  • "dueDate": "2025-05-16T10:15:48.769+00:00",
  • "action": "checkedout",
  • "feesAndFines": {
    },
  • "metadata": {
    },
  • "isDcb": false,
  • "itemEffectiveLocationIdAtCheckOut": "fcd64ce1-6995-48f0-840e-89ffa2288371",
  • "checkoutServicePointId": "3a40852d-49fd-4df2-a1f9-6e2641a6e91f",
  • "patronGroupAtCheckout": {
    },
  • "status": {
    }
}

declareItemLost

Declare item lost for a loan

path Parameters
loanId
required
string <uuid>
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
}