API docs by Redocly

INN-Reach Circulation API (v1)

central-server-configuration

getCentralServerAgencies

Get a combined list of agencies available from all configured central servers

Responses

Response samples

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

getCentralServerItemTypes

Get a combined list of item types available from all configured central servers

Responses

Response samples

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

getCentralServerPatronTypes

Get a combined list of patron types available from all configured central servers

Responses

Response samples

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

bib-info-d2ir

getBibRecord

Handles D2IR request from central server for an already-contributed Bib record.

path Parameters
bibId
required
string

32-character, alphanumeric id corresponding to a FOLIO instance record HRID

centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Responses

Response samples

Content type
application/json
{
  • "bibInfo": {
    },
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

inn-reach-circulation

createInnReachTransactionItemHold

Originates an item hold at the owning site

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
id
string <UUID>

Transaction Hold id

transactionTime
required
integer

Transaction time

pickupLocation
required
string

Pickup location

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string = 5 characters

Patron agency code

itemAgencyCode
required
string = 5 characters

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

needBefore
integer

Need before time

dueDateTime
integer

Due date time

centralItemType
integer [ 0 .. 255 ]

Central item type

centralPatronType
integer [ 0 .. 255 ]

Central patron type

patronName
string

Patron name

patronHomeLibrary
string

Patron home library

patronPhone
string

Patron phone

title
string

Patron hold title

author
string

Patron hold author

callNumber
string

Patron hold call number

shippedItemBarcode
string

Shipped item barcode

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",
  • "transactionTime": 0,
  • "pickupLocation": "string",
  • "patronId": "string",
  • "patronAgencyCode": "strin",
  • "itemAgencyCode": "strin",
  • "itemId": "string",
  • "needBefore": 0,
  • "dueDateTime": 0,
  • "centralItemType": 255,
  • "centralPatronType": 255,
  • "patronName": "string",
  • "patronHomeLibrary": "string",
  • "patronPhone": "string",
  • "title": "string",
  • "author": "string",
  • "callNumber": "string",
  • "shippedItemBarcode": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

patronHold

Originate a patron hold

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
pickupLocation
required
string

Pickup location

centralItemType
required
integer [ 0 .. 255 ]

Central item type

title
string <= 256 characters

Item title

author
string <= 256 characters

Author

callNumber
string <= 256 characters

Call number

needBefore
integer

Need before time

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "pickupLocation": "string",
  • "centralItemType": 255,
  • "title": "string",
  • "author": "string",
  • "callNumber": "string",
  • "needBefore": 0,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

itemShipped

Process shipped item

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
pickupLocation
required
string

Pickup location

centralItemType
required
integer [ 0 .. 255 ]

Central item type

itemBarcode
string

Item barcode

title
string <= 256 characters

Item title

author
string <= 256 characters

Author

callNumber
string <= 256 characters

Call number

itemLocation
string

Item location

needBefore
integer

Need before time

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "pickupLocation": "string",
  • "centralItemType": 255,
  • "itemBarcode": "string",
  • "title": "string",
  • "author": "string",
  • "callNumber": "string",
  • "itemLocation": "string",
  • "needBefore": 0,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

cancelPatronHold

Cancel Patron Hold transaction

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
reason
string

Cancellation reason

reasonCode
required
integer

Cancellation reason code (always 7)

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "reasonCode": 0,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

transferRequest

Put transfer request

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
newItemId
required
string[a-z,0-9]{1,32}

New item id

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "newItemId": "string",
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

cancelItemHold

Cancel an item request

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

receiveUnshipped

Report unshipped item received to owning site for item hold

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

itemInTransit

Receives message from central server to owning site indicating that a loaned item is being returned after being loaned to the borrowing patron.

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

returnUncirculated

Return uncirculated message for item hold

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
title
string <= 256 characters

Item title

author
string

Author

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "author": "string",
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

createLocalHold

Create Local Hold - Central server to owning site when a local patron of that site requests an item through central.

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
pickupLocation
required
string

Pickup location

centralItemType
required
integer [ 0 .. 255 ]

Central item type

centralPatronType
required
integer [ 0 .. 255 ]

Central patron type

patronName
required
string

Patron name

patronHomeLibrary
string

Patron home library

patronPhone
string

Patron phone

title
string <= 256 characters

Item title

author
string <= 256 characters

Author

callNumber
string <= 256 characters

Call number

needBefore
integer

Need before time

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "pickupLocation": "string",
  • "centralItemType": 255,
  • "centralPatronType": 255,
  • "patronName": "string",
  • "patronHomeLibrary": "string",
  • "patronPhone": "string",
  • "title": "string",
  • "author": "string",
  • "callNumber": "string",
  • "needBefore": 0,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

itemReceived

Shipped item has been received

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
centralItemType
required
integer [ 0 .. 255 ]

Central item type

title
string <= 256 characters

Item title

author
string <= 256 characters

Author

itemBarcode
string

Item barcode

callNumber
string <= 256 characters

Call number

centralPatronType
required
integer [ 0 .. 255 ]

Central patron type

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "centralItemType": 255,
  • "title": "string",
  • "author": "string",
  • "itemBarcode": "string",
  • "callNumber": "string",
  • "centralPatronType": 255,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

recall

Item has been recalled

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
dueDateTime
required
integer

Due date time

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "dueDateTime": 0,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

borrowerRenew

Borrower Renew Message for Item Hold

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
dueDateTime
required
integer

Due date time

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "dueDateTime": 0,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

finalCheckIn

Indicating that a returned item has been received by its owning site. This is a terminating transaction.

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

ownerRenew

Owner Renew loan

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
dueDateTime
required
integer

Due date time

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "dueDateTime": 0,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

claimsReturned

Borrower claims item returned

path Parameters
trackingId
required
string
centralCode
required
string (code) [a-z,0-9]{3,5}

Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status)

Request Body schema: application/json
claimsReturnedDate
required
integer

Claims returned date (date of -1 indicates date unknown)

transactionTime
required
integer

Transaction time

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string[a-z,0-9]{5}

Patron agency code

itemAgencyCode
required
string[a-z,0-9]{5}

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

Responses

Request samples

Content type
application/json
{
  • "claimsReturnedDate": 0,
  • "transactionTime": 0,
  • "patronId": "string",
  • "patronAgencyCode": "string",
  • "itemAgencyCode": "string",
  • "itemId": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

inn-reach-transaction

getAllTransactions

Get a list of transactions for the given central server

query Parameters
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

object (innReachTransactionFilterParametersDTO)

Query parameters to filter transactions.

Responses

Response samples

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

getInnReachTransaction

get inn-reach transaction by id

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "trackingId": "string",
  • "centralServerCode": "string",
  • "state": "ITEM_HOLD",
  • "type": "ITEM",
  • "hold": {
    },
  • "metadata": {
    }
}

updateInnReachTransaction

update inn-reach transaction by id

path Parameters
id
required
string <uuid>
Request Body schema: application/json
id
string <UUID>

Transaction id

trackingId
string

ID for transaction tracking

centralServerCode
string

Unique code that identifies the central server

state
string (Transaction State enum)
Enum: "ITEM_HOLD" "PATRON_HOLD" "LOCAL_HOLD" "BORROWER_RENEW" "BORROWING_SITE_CANCEL" "ITEM_IN_TRANSIT" "RECEIVE_UNANNOUNCED" "RETURN_UNCIRCULATED" "CLAIMS_RETURNED" "ITEM_RECEIVED" "ITEM_SHIPPED" "LOCAL_CHECKOUT" "CANCEL_REQUEST" "FINAL_CHECKIN" "RECALL" "TRANSFER" "OWNER_RENEW"

Transaction State enum

type
string (Transaction Type enum)
Enum: "ITEM" "PATRON" "LOCAL"

Transaction Type enum

object (transactionHoldDTO)

INN-Reach Transaction hold record

id
string <UUID>

Transaction Hold id

transactionTime
required
integer

Transaction time

pickupLocation
required
string

Pickup location

patronId
required
string[a-z,0-9]{1,32}

Patron id

patronAgencyCode
required
string = 5 characters

Patron agency code

itemAgencyCode
required
string = 5 characters

Item agency code

itemId
required
string[a-z,0-9]{1,32}

Item id

needBefore
integer

Need before time

dueDateTime
integer

Due date time

centralItemType
integer [ 0 .. 255 ]

Central item type

centralPatronType
integer [ 0 .. 255 ]

Central patron type

patronName
string

Patron name

patronHomeLibrary
string

Patron home library

patronPhone
string

Patron phone

title
string

Patron hold title

author
string

Patron hold author

callNumber
string

Patron hold call number

shippedItemBarcode
string

Shipped item barcode

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

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",
  • "trackingId": "string",
  • "centralServerCode": "string",
  • "state": "ITEM_HOLD",
  • "type": "ITEM",
  • "hold": {
    },
  • "metadata": {
    }
}

Response samples

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

checkInPatronHoldItem

receive item for patron hold transaction

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "folioCheckIn": {
    },
  • "barcodeAugmented": true
}

checkInPatronHoldUnshippedItem

receive un-shipped/unannounced item for patron hold transaction

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "folioCheckIn": {
    },
  • "barcodeAugmented": true
}

finalCheckInItemHold

Final check-in of an item loaned through INN-Reach

path Parameters
id
required
string <uuid>

Responses

Response samples

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

transferItemHold

Transfer item hold to another item

path Parameters
id
required
string <uuid>

Responses

Response samples

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

checkOutPatronHoldItem

Checks out to requesting patron

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "folioCheckOut": {
    }
}

checkOutLocalHoldItem

Checks out Local Hold item to requesting patron

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "folioCheckOut": {
    }
}

checkOutItemHoldItem

checks out an item from the owning site to the borrowing site for an Item Hold transaction

Responses

Response samples

Content type
application/json
{
  • "transaction": {
    },
  • "folioCheckOut": {
    }
}

cancelPatronHoldTransaction

Cancel patron hold transaction with the reason provided

path Parameters
id
required
string <uuid>
Request Body schema: application/json
cancellationReasonId
required
string <UUID>

Cancellation reason id

cancellationAdditionalInformation
string

Additional information about cancellation

Responses

Request samples

Content type
application/json
{
  • "cancellationReasonId": "string",
  • "cancellationAdditionalInformation": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "trackingId": "string",
  • "centralServerCode": "string",
  • "state": "ITEM_HOLD",
  • "type": "ITEM",
  • "hold": {
    },
  • "metadata": {
    }
}

removePatronHoldTransaction

Cancel patron hold transaction which does not have associated item and request details

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "trackingId": "string",
  • "centralServerCode": "string",
  • "state": "ITEM_HOLD",
  • "type": "ITEM",
  • "hold": {
    },
  • "metadata": {
    }
}

recallItemHoldTransaction

Recall item hold transaction

path Parameters
id
required
string <uuid>

Responses

Response samples

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

returnPatronHoldItem

Returns Patron Hold item

path Parameters
id
required
string <uuid>

Responses

Response samples

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

cancelItemHoldTransaction

Cancel item hold transaction with the reason provided

path Parameters
id
required
string <uuid>
Request Body schema: application/json
cancellationReasonId
required
string <UUID>

Cancellation reason id

cancellationAdditionalInformation
string

Additional information about cancellation

Responses

Request samples

Content type
application/json
{
  • "cancellationReasonId": "string",
  • "cancellationAdditionalInformation": "string"
}

Response samples

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

cancelLocalHoldTransaction

Cancel local hold transaction with the reason provided

path Parameters
id
required
string <uuid>
Request Body schema: application/json
cancellationReasonId
required
string <UUID>

Cancellation reason id

cancellationAdditionalInformation
string

Additional information about cancellation

Responses

Request samples

Content type
application/json
{
  • "cancellationReasonId": "string",
  • "cancellationAdditionalInformation": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "trackingId": "string",
  • "centralServerCode": "string",
  • "state": "ITEM_HOLD",
  • "type": "ITEM",
  • "hold": {
    },
  • "metadata": {
    }
}

transferLocalHold

Transfer local hold to another item

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "trackingId": "string",
  • "centralServerCode": "string",
  • "state": "ITEM_HOLD",
  • "type": "ITEM",
  • "hold": {
    },
  • "metadata": {
    }
}

verify-patron-d2ir

verifyPatron

Handles D2IR request from central server for patron verification.

header Parameters
X-To-Code
required
string (code) [a-z,0-9]{3,5}
X-From-Code
required
string (code) [a-z,0-9]{3,5}
Request Body schema: application/json
patronName
required
string <= 128 characters

Patron name

patronAgencyCode
required
string <= 128 characters

Patron agency code

visiblePatronId
required
string <= 32 characters

User attribute configured by the system to act as their publicId (externalSystemId or barcode)

Responses

Request samples

Content type
application/json
{
  • "patronName": "string",
  • "patronAgencyCode": "string",
  • "visiblePatronId": "string"
}

Response samples

Content type
application/json
{
  • "patronInfo": {
    },
  • "requestAllowed": true,
  • "status": "string",
  • "reason": "string",
  • "errors": [
    ]
}

paging-slip

getPagingSlips

Get a list of available tokens for INN-Reach paging slips

Responses

Response samples

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