API docs by Redocly

mod DCB FOLIO API (1.0.0)

mod DCB FOLIO API

transactions

createCirculationRequest

Create circulation request

path Parameters
dcbTransactionId
required
string
Request Body schema: application/json
required

DCB transaction object

object (DcbItem)

Item metadata required for the transaction

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/

title
string

The title of the item that has been requested

barcode
string

The barcode of the item as specified in the lending library

materialType
string

The “hub-normalized” form of the item item type, used in the circulation rules for determining the correct loan policy.

lendingLibraryCode
string

The code which identifies the lending library

locationCode
string

The location code of the item, representing the library agency code used for determining loan policy flexibility.

object (renewalInfo)
holdCount
integer

The number of holds on the item (Will be returned only for Lender role)

object (DcbPatron)

Patron metadata required for the transaction

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/

group
string

The patron group associated with the requesting patron

barcode
string

The barcode of the patron

localNames
string

The local names for the patron, for example: "[John, Johnny, Doe]"

object (DcbPickup)

Pickup Location metadata required for the pickup service point

libraryCode
string

The code which identifies the pickup library

servicePointId
string

UUID of the pickup service point

servicePointName
string

The name of the pickup service point

requestId
string

ID of the existing circulation TLR

selfBorrowing
boolean

selfBorrowing flag for BORROWING_PICKUP role to allow patrons to request items from own library via DCB

role
string
Enum: "LENDER" "BORROWER" "PICKUP" "BORROWING-PICKUP"

Responses

Request samples

Content type
application/json
{
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

Response samples

Content type
application/json
{
  • "status": "CREATED",
  • "message": "string",
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

updateTransactionDetails

Update the details of a transaction

path Parameters
dcbTransactionId
required
string
Request Body schema: application/json
required

DCB transaction update object

object (DcbUpdateItem)

Item metadata required for updating the existing transaction

barcode
required
string

The barcode of the item as specified in the lending library

materialType
required
string

The “hub-normalized” form of the item item type, used in the circulation rules for determining the correct loan policy.

lendingLibraryCode
required
string

The code which identifies the lending library

Responses

Request samples

Content type
application/json
{
  • "item": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

getTransactionStatusById

Get transaction status across circulation institutions

path Parameters
dcbTransactionId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "CREATED",
  • "message": "string",
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

updateTransactionStatus

Update transaction status across circulation institutions

path Parameters
dcbTransactionId
required
string
Request Body schema: application/json

TransactionStatus object

status
string
Enum: "CREATED" "OPEN" "AWAITING_PICKUP" "ITEM_CHECKED_OUT" "ITEM_CHECKED_IN" "EXPIRED" "CLOSED" "CANCELLED" "ERROR"
message
string

Responses

Request samples

Content type
application/json
{
  • "status": "CREATED",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "status": "CREATED",
  • "message": "string",
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

getTransactionStatusList

Get a list of updated transactions between from date and to date with optional filtering and pagination

query Parameters
fromDate
required
string <date-time>

Start date for filtering transactions

toDate
required
string <date-time>

End date for filtering transactions

pageNumber
integer [ 0 .. 2147483647 ]
Default: 0

Page number for pagination (optional)

pageSize
integer [ 1 .. 2147483647 ]
Default: 1000

Number of items per page (optional)

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ],
  • "currentPageNumber": 0,
  • "currentPageSize": 0,
  • "maximumPageNumber": 0,
  • "totalRecords": 0
}

renewItemLoanByTransactionId

Increment the renew loan count and returned transaction status with renewal details

path Parameters
dcbTransactionId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "CREATED",
  • "message": "string",
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

blockItemRenewalByTransactionId

Set the renewal count for the item in DCB transaction to maximum allowed renewals

path Parameters
dcbTransactionId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

unblockItemRenewalByTransactionId

Set the renewal count for the item in DCB transaction to zero

path Parameters
dcbTransactionId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

ecs-request-transactions

createEcsRequestTransactions

Create transaction for existing circulation TLR

path Parameters
ecsRequestTransactionId
required
string
Request Body schema: application/json
required

DCB transaction object

object (DcbItem)

Item metadata required for the transaction

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/

title
string

The title of the item that has been requested

barcode
string

The barcode of the item as specified in the lending library

materialType
string

The “hub-normalized” form of the item item type, used in the circulation rules for determining the correct loan policy.

lendingLibraryCode
string

The code which identifies the lending library

locationCode
string

The location code of the item, representing the library agency code used for determining loan policy flexibility.

object (renewalInfo)
holdCount
integer

The number of holds on the item (Will be returned only for Lender role)

object (DcbPatron)

Patron metadata required for the transaction

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/

group
string

The patron group associated with the requesting patron

barcode
string

The barcode of the patron

localNames
string

The local names for the patron, for example: "[John, Johnny, Doe]"

object (DcbPickup)

Pickup Location metadata required for the pickup service point

libraryCode
string

The code which identifies the pickup library

servicePointId
string

UUID of the pickup service point

servicePointName
string

The name of the pickup service point

requestId
string

ID of the existing circulation TLR

selfBorrowing
boolean

selfBorrowing flag for BORROWING_PICKUP role to allow patrons to request items from own library via DCB

role
string
Enum: "LENDER" "BORROWER" "PICKUP" "BORROWING-PICKUP"

Responses

Request samples

Content type
application/json
{
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

Response samples

Content type
application/json
{
  • "status": "CREATED",
  • "message": "string",
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

updateEcsRequestTransaction

Update ECS request transaction

path Parameters
ecsRequestTransactionId
required
string
Request Body schema: application/json
required

DCB transaction object

object (DcbItem)

Item metadata required for the transaction

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/

title
string

The title of the item that has been requested

barcode
string

The barcode of the item as specified in the lending library

materialType
string

The “hub-normalized” form of the item item type, used in the circulation rules for determining the correct loan policy.

lendingLibraryCode
string

The code which identifies the lending library

locationCode
string

The location code of the item, representing the library agency code used for determining loan policy flexibility.

object (renewalInfo)
holdCount
integer

The number of holds on the item (Will be returned only for Lender role)

object (DcbPatron)

Patron metadata required for the transaction

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/

group
string

The patron group associated with the requesting patron

barcode
string

The barcode of the patron

localNames
string

The local names for the patron, for example: "[John, Johnny, Doe]"

object (DcbPickup)

Pickup Location metadata required for the pickup service point

libraryCode
string

The code which identifies the pickup library

servicePointId
string

UUID of the pickup service point

servicePointName
string

The name of the pickup service point

requestId
string

ID of the existing circulation TLR

selfBorrowing
boolean

selfBorrowing flag for BORROWING_PICKUP role to allow patrons to request items from own library via DCB

role
string
Enum: "LENDER" "BORROWER" "PICKUP" "BORROWING-PICKUP"

Responses

Request samples

Content type
application/json
{
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

Response samples

Content type
application/json
{
  • "status": "CREATED",
  • "message": "string",
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "requestId": "string",
  • "selfBorrowing": true,
  • "role": "LENDER"
}

RefreshShadowLocations

refreshShadowLocation

Refresh shadow location

Request Body schema: application/json
required

DCB hub shadow location refresh request body

Array of objects (DcbAgency)
Array
name
required
string

Name of the agency

code
required
string

Code of the agency

Array of objects (DcbLocation)
Array
name
required
string

Name of the location

code
required
string

Code of the location

required
object (DcbAgency)

DCB Agency object

Responses

Request samples

Content type
application/json
{
  • "agencies": [
    ],
  • "locations": [
    ]
}

Response samples

Content type
application/json
{
  • "locations": [
    ],
  • "location-units": {
    }
}

setting

findDcbSettings

Search DCB settings by CQL query with pagination

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

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

limit
integer >= 0
Default: 50
Example: limit=100

Limit the number of elements returned in the response.

offset
integer >= 0
Default: 0

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

Responses

Response samples

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

createDcbSetting

Create DCB setting

Request Body schema: application/json
required

DCB setting to create

id
required
string <uuid>

Setting Identifier

scope
required
string (SettingScope)
Value: "mod-dcb"

Scope for this entry (normally a module)

key
required
string

Key within scope for this setting

value
required
object

Settings value (any type)

_version
integer

Record version for optimistic locking

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope": "mod-dcb",
  • "key": "string",
  • "value": { },
  • "_version": 0,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope": "mod-dcb",
  • "key": "string",
  • "value": { },
  • "_version": 0,
  • "metadata": {
    }
}

getDcbSettingById

Get DCB setting by id

path Parameters
id
required
string <uuid>
Example: 1e111e76-1111-401c-ad8e-0d121a11111e

Record identifier

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope": "mod-dcb",
  • "key": "string",
  • "value": { },
  • "_version": 0,
  • "metadata": {
    }
}

updateDcbSettingById

Update DCB setting by id

path Parameters
id
required
string <uuid>
Example: 1e111e76-1111-401c-ad8e-0d121a11111e

Record identifier

Request Body schema: application/json
required

DCB setting to update

id
required
string <uuid>

Setting Identifier

scope
required
string (SettingScope)
Value: "mod-dcb"

Scope for this entry (normally a module)

key
required
string

Key within scope for this setting

value
required
object

Settings value (any type)

_version
integer

Record version for optimistic locking

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "scope": "mod-dcb",
  • "key": "string",
  • "value": { },
  • "_version": 0,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

deleteDcbSettingById

Delete DCB setting by id

path Parameters
id
required
string <uuid>
Example: 1e111e76-1111-401c-ad8e-0d121a11111e

Record identifier

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}