API docs by Redocly

ECS TLR API (v1)

ecsTlr

postEcsTlr

Create ECS TLR

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
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/

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/

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

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

intermediateRequestId
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/

intermediateRequestDcbTransactionId
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/

intermediateRequestTenantId
string

ID of the tenant intermediate request was created in

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "instanceId": "string",
  • "requesterId": "string",
  • "requestType": "Hold",
  • "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",
  • "intermediateRequestId": "string",
  • "intermediateRequestDcbTransactionId": "string",
  • "intermediateRequestTenantId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "instanceId": "string",
  • "requesterId": "string",
  • "requestType": "Hold",
  • "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",
  • "intermediateRequestId": "string",
  • "intermediateRequestDcbTransactionId": "string",
  • "intermediateRequestTenantId": "string"
}

getEcsTlrById

Retrieve ECS TLR by ID

path Parameters
requestId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "instanceId": "string",
  • "requesterId": "string",
  • "requestType": "Hold",
  • "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",
  • "intermediateRequestId": "string",
  • "intermediateRequestDcbTransactionId": "string",
  • "intermediateRequestTenantId": "string"
}

putEcsTlrById

Update ECS TLR by ID

path Parameters
requestId
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/

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/

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/

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

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

intermediateRequestId
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/

intermediateRequestDcbTransactionId
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/

intermediateRequestTenantId
string

ID of the tenant intermediate request was created in

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "instanceId": "string",
  • "requesterId": "string",
  • "requestType": "Hold",
  • "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",
  • "intermediateRequestId": "string",
  • "intermediateRequestDcbTransactionId": "string",
  • "intermediateRequestTenantId": "string"
}

Response samples

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

deleteEcsTlrById

Remove ECS TLR by ID

path Parameters
requestId
required
string <uuid>

Responses

Response samples

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