API docs by Redocly

Edge DCB FOLIO API (1.0.0)

Edge DCB FOLIO API

circulation

Create DCB transaction 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 material 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)
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

borrowingLibraryCode
string

The code which identifies the borrowing library

object (DcbPickup)

Pickup Location metadata required for the pickup service point

libraryName
string

The name of the pickup library

libraryCode
string

The code which identifies the pickup library

servicePointId
string

The code which identifies the pickup service point

servicePointName
string

The name of the pickup service point

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": {
    },
  • "selfBorrowing": true,
  • "role": "LENDER"
}

Response samples

Content type
application/json
{
  • "status": "CREATED",
  • "message": "string",
  • "item": {
    },
  • "patron": {
    },
  • "pickup": {
    },
  • "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": [
    ]
}

getDCBTransactionStatusById

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": {
    },
  • "selfBorrowing": true,
  • "role": "LENDER"
}

updateDCBTransactionStatus

Update transaction status across circulation institutions

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

TransactionStatus object

status
string
Enum: "CREATED" "OPEN" "CANCELLED" "IN_TRANSIT" "AWAITING_PICKUP" "ITEM_CHECKED_OUT" "ITEM_CHECKED_IN" "IN_TRANSIT_TO_LENDING" "CLOSED" "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": {
    },
  • "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": {
    },
  • "selfBorrowing": true,
  • "role": "LENDER"
}