foliolib.folio.api.innReach.Circulation
- class foliolib.folio.api.innReach.Circulation(tenant: str)
Bases:
foliolib.folio.FolioApiINN-Reach Circulation API
Base class of the Folio API
- Parameters
tenant (str) – Tenant id
Methods
borrowerrenew(trackingId, centralCode, ...)Borrower Renew Message for Item Hold
cancelitemhold(trackingId, centralCode, ...)Cancel an item request
Cancel item hold transaction with the reason provided
Cancel local hold transaction with the reason provided
cancelpatronhold(trackingId, centralCode, ...)Cancel Patron Hold transaction
Cancel patron hold transaction with the reason provided
checkinpatronholditem(servicePointId, id_)receive item for patron hold transaction
receive un-shipped/unannounced item for patron hold transaction
checkoutitemholditem(itemBarcode, servicePointId)checks out an item from the owning site to the borrowing site for an Item Hold transaction
checkoutlocalholditem(servicePointId, id_)Checks out Local Hold item to requesting patron
checkoutpatronholditem(servicePointId, id_)Checks out to requesting patron
claimsreturned(trackingId, centralCode, ...)Borrower claims item returned
Originates an item hold at the owning site
createlocalhold(trackingId, centralCode, ...)Create Local Hold - Central server to owning site when a local patron of that site requests an item through central.
finalcheckin(trackingId, centralCode, ...)Indicating that a returned item has been received by its owning site.
finalcheckinitemhold(servicePointId, id_)Final check-in of an item loaned through INN-Reach
getalltransactions(**kwargs)Get a list of transactions for the given central server
getbibrecord(bibId, centralCode)Handles D2IR request from central server for an already-contributed Bib record.
Get a combined list of agencies available from all configured central servers
Get a combined list of item types available from all configured central servers
Get a combined list of patron types available from all configured central servers
get inn-reach transaction by id
getpagingslips(servicePointId)Get a list of available tokens for INN-Reach paging slips
itemintransit(trackingId, centralCode, ...)Receives message from central server to owning site indicating that a loaned item is being returned after being loaned to the borrowing patron.
itemreceived(trackingId, centralCode, ...)Shipped item has been received
itemshipped(trackingId, centralCode, ...)Process shipped item
ownerrenew(trackingId, centralCode, renewLoanDTO)Owner Renew loan
patronhold(trackingId, centralCode, ...)Originate a patron hold
recall(trackingId, centralCode, recallDTO)Item has been recalled
Recall item hold transaction
receiveunshipped(trackingId, centralCode, ...)Report unshipped item received to owning site for item hold
returnpatronholditem(servicePointId, id_)Returns Patron Hold item
returnuncirculated(trackingId, centralCode, ...)Return uncirculated message for item hold
transferitemhold(itemId, id_)Transfer item hold to another item
transferlocalhold(itemId, id_)Transfer local hold to another item
transferrequest(trackingId, centralCode, ...)Put transfer request
update inn-reach transaction by id
verifypatron(patronInfoRequestDTO)Handles D2IR request from central server for patron verification.
- borrowerrenew(trackingId, centralCode, renewLoanDTO)
Borrower Renew Message for Item Hold
PUT /inn-reach/d2ir/circ/borrowerrenew/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
renewLoanDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Renew loan request", "type": "object", "properties": { "dueDateTime": { "description": "Due date time", "type": "integer" } }, "additionalProperties": false, "required": [ "dueDateTime" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- cancelitemhold(trackingId, centralCode, baseCircRequestDTO)
Cancel an item request
PUT /inn-reach/d2ir/circ/cancelitemhold/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
baseCircRequestDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach Circulation Common Put Request Data", "type": "object", "properties": { "transactionTime": { "description": "Transaction time", "type": "integer" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "pattern": "[a-z,0-9]{5}" }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "pattern": "[a-z,0-9]{5}" }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" } }, "additionalProperties": false, "required": [ "transactionTime", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- cancelitemholdtransaction(cancelTransactionHoldDTO, id_)
Cancel item hold transaction with the reason provided
POST /inn-reach/transactions/{id}/itemhold/cancel- Parameters
cancelTransactionHoldDTO (dict) – See Schema below.
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Transaction hold cancellation request", "type": "object", "properties": { "cancellationReasonId": { "description": "Cancellation reason id", "type": "string", "format": "UUID" }, "cancellationAdditionalInformation": { "description": "Additional information about cancellation", "type": "string" } }, "additionalProperties": false, "required": [ "cancellationReasonId" ] }
- cancellocalholdtransaction(cancelTransactionHoldDTO, id_)
Cancel local hold transaction with the reason provided
POST /inn-reach/transactions/{id}/localhold/cancel- Parameters
cancelTransactionHoldDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Transaction hold cancellation request", "type": "object", "properties": { "cancellationReasonId": { "description": "Cancellation reason id", "type": "string", "format": "UUID" }, "cancellationAdditionalInformation": { "description": "Additional information about cancellation", "type": "string" } }, "additionalProperties": false, "required": [ "cancellationReasonId" ] }
{ "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }
- cancelpatronhold(trackingId, centralCode, cancelRequestDTO)
Cancel Patron Hold transaction
PUT /inn-reach/d2ir/circ/cancelrequest/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
cancelRequestDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Cancel request", "type": "object", "properties": { "reason": { "description": "Cancellation reason", "type": "string" }, "reasonCode": { "description": "Cancellation reason code (always 7)", "type": "integer" } }, "additionalProperties": false, "required": [ "reasonCode" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- cancelpatronholdtransaction(cancelTransactionHoldDTO, id_)
Cancel patron hold transaction with the reason provided
POST /inn-reach/transactions/{id}/patronhold/cancel- Parameters
cancelTransactionHoldDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Transaction hold cancellation request", "type": "object", "properties": { "cancellationReasonId": { "description": "Cancellation reason id", "type": "string", "format": "UUID" }, "cancellationAdditionalInformation": { "description": "Additional information about cancellation", "type": "string" } }, "additionalProperties": false, "required": [ "cancellationReasonId" ] }
{ "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }
- checkinpatronholditem(servicePointId, id_)
receive item for patron hold transaction
POST /inn-reach/transactions/{id}/receive-item/{servicePointId}- Parameters
servicePointId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Receive Item for Patron Hold Transaction", "type": "object", "properties": { "transaction": { "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }, "folioCheckIn": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "description": "Success response for checking in an item at a service point", "properties": { "loan": { "description": "Loan affected by the check in (may be none, if a receiving check in)", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Loan", "properties": { "id": { "description": "Unique ID (generated UUID) of the loan", "type": "string", "format": "UUID" }, "userId": { "description": "ID of the patron the item was lent to. Required for open loans, not required for closed loans (for anonymization).", "type": "string", "format": "UUID" }, "borrower": { "description": "Additional information about the borrower of the item, taken from the user referred to by the userId", "readonly": true, "type": "object", "properties": { "firstName": { "description": "first name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "lastName": { "description": "last name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "middleName": { "description": "middle name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "barcode": { "description": "barcode used to identify the borrower (read only, defined by the server)", "type": "string", "readonly": true } }, "additionalProperties": false }, "proxyUserId": { "description": "ID of the user representing a proxy for the patron", "type": "string", "format": "UUID" }, "itemId": { "description": "ID of the item lent to the patron", "type": "string", "format": "UUID" }, "loanPolicyId": { "description": "ID of last policy used in relation to this loan", "type": "string", "format": "UUID" }, "loanPolicy": { "description": "Additional information about the loan policy of the item, taken from the loan loanPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "overdueFinePolicyId": { "description": "ID of last overdue fine policy used in relation to this loan", "type": "string", "format": "UUID" }, "overdueFinePolicy": { "description": "Additional information about the overdue fine policy of the item, taken from the loan overdueFinePolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last overdue fine policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "lostItemPolicyId": { "description": "ID of last lost item policy used in relation to this loan", "type": "string", "format": "UUID" }, "lostItemPolicy": { "description": "Additional information about the lost item policy of the item, taken from the loan lostItemPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last lost item policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "item": { "description": "Additional information about the item", "type": "object", "readonly": true, "properties": { "id": { "description": "ID of the item", "type": "string", "format": "UUID", "readonly": true }, "title": { "description": "The title of the item lent to the patron", "type": "string", "readonly": true }, "callNumber": { "description": "Deprecated call number from the holdings record, use callNumberComponents.callNumber instead", "type": "string", "readonly": true }, "materialType": { "description": "The material type from the item record", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the material type", "type": "string", "readonly": true } }, "additionalProperties": false }, "contributors": { "description": "Contributors from the instance record", "type": "array", "readonly": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the contributor", "type": "string", "readonly": true } }, "additionalProperties": false } }, "holdingsRecordId": { "description": "The ID of the holdings for the item", "type": "string", "format": "UUID", "readonly": true }, "instanceId": { "description": "The ID of the instance for the item", "type": "string", "format": "UUID", "readonly": true }, "barcode": { "description": "The barcode of the item", "type": "string", "readonly": true }, "location": { "description": "The effective location of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "The name of the location", "type": "string", "readonly": true } } }, "status": { "description": "Overall status of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the item status", "type": "string", "readonly": true }, "date": { "type": "string", "description": "Date time when status was last changed", "format": "date-time", "readonly": true } }, "additionalProperties": false }, "inTransitDestinationServicePointId": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "string", "format": "UUID", "readonly": true }, "inTransitDestinationServicePoint": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true } } }, "enumeration": { "description": "Item`s enumeration", "type": "string", "readonly": true }, "chronology": { "description": "Item`s chronology", "type": "string", "readonly": true }, "volume": { "description": "Item`s volume", "type": "string", "readonly": true }, "callNumberComponents": { "description": "Elements of a full call number", "readonly": true, "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "callNumber": { "type": "string", "description": "Call number for item", "readonly": true }, "prefix": { "description": "Call number prefix for item", "type": "string", "readonly": true }, "suffix": { "description": "Call number suffix for item", "type": "string", "readonly": true } } } }, "additionalProperties": false }, "itemEffectiveLocationIdAtCheckOut": { "description": "The effective location, at the time of checkout, of the item loaned to the patron.", "type": "string", "format": "UUID" }, "status": { "description": "Overall status of the loan", "type": "object", "properties": { "name": { "description": "Name of the status (currently can be any value, values commonly used are Open and Closed)", "type": "string" } } }, "loanDate": { "description": "Date and time when the loan began", "type": "string", "format": "date-time" }, "dueDate": { "description": "Date and time when the item is due to be returned", "type": "string", "format": "date-time" }, "returnDate": { "description": "Date and time when the item was returned", "type": "string", "format": "date-time" }, "systemReturnDate": { "description": "Date and time when return was processed", "type": "string", "format": "date-time" }, "action": { "description": "Last action performed on a loan (currently can be any value, values commonly used are checkedout and checkedin)", "type": "string" }, "renewalCount": { "description": "Count of how many times a loan has been renewed (incremented by the client)", "type": "integer", "minimum": 0 }, "checkoutServicePointId": { "description": "ID of the Service Point where the last checkout occured", "type": "string", "format": "UUID" }, "checkinServicePointId": { "description": "ID of the Service Point where the last checkin occured", "type": "string", "format": "UUID" }, "checkoutServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "The unique name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "checkinServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "patronGroupAtCheckout": { "description": "Patron Group at checkout", "type": "object", "properties": { "id": { "description": "Unique ID (generated UUID) of the patron group", "type": "string", "format": "UUID", "readonly": true }, "name": { "description": "Patron group name", "type": "string", "readonly": true } }, "additionalProperties": false }, "feesAndFines": { "description": "Fees and fines associated with loans", "type": "object", "properties": { "amountRemainingToPay": { "type": "number", "description": "Total remaining amount due on fees and fines for the loan (read only, defined by the server)", "readonly": true } }, "additionalProperties": false }, "declaredLostDate": { "description": "Date and time the item was declared lost during this loan", "type": "string", "format": "date-time" }, "metadata": { "description": "Metadata about creation and changes to loan, provided by the server (client should not provide)", "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "title": "Metadata Schema", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "UUID" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "UUID" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "required": [ "itemId", "loanDate", "action" ] }, "item": { "description": "Additional information about the item", "type": "object", "properties": { "id": { "description": "ID of the item", "type": "string" }, "title": { "description": "The title of the item lent to the patron", "type": "string" }, "callNumber": { "description": "The call number from the holdings record", "type": "string" }, "materialType": { "description": "The material type from the item record", "type": "object", "properties": { "name": { "description": "Name of the material type", "type": "string" } }, "additionalProperties": false }, "contributors": { "description": "Contributors from the instance record", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Name of the contributor", "type": "string" } }, "additionalProperties": false } }, "holdingsRecordId": { "description": "The ID of the holdings for the item", "type": "string" }, "instanceId": { "description": "The ID of the instance for the item", "type": "string" }, "barcode": { "description": "The barcode of the item", "type": "string" }, "location": { "description": "The effective location of the item", "type": "object", "properties": { "name": { "description": "The name of the location", "type": "string" } }, "additionalProperties": false }, "status": { "description": "Overall status of the item", "type": "object", "properties": { "name": { "description": "Name of the item status", "type": "string" }, "date": { "type": "string", "description": "Date time when status was last changed", "format": "date-time" } }, "additionalProperties": false }, "enumeration": { "description": "Item`s enumeration", "type": "string" }, "chronology": { "description": "Chronology is the descriptive information for the dating scheme of a serial.", "type": "string" }, "volume": { "description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of George Bernard Shaw in three volumes).", "type": "string" }, "inTransitDestinationServicePointId": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "string", "format": "UUID" }, "inTransitDestinationServicePoint": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "object", "properties": { "name": { "description": "Name of the service point", "type": "string" } } } }, "additionalProperties": false }, "staffSlipContext": { "description": "Context for staff slip tokens", "type": "object" }, "inHouseUse": { "type": "boolean", "description": "Defines whether the current check-in operation considered as in-house use or not." } }, "additionalProperties": false }, "barcodeAugmented": { "description": "indicates if the FOLIO item's barcode was augmented to avoid duplicate barcode collision (item agency code appended)", "type": "boolean" } }, "additionalProperties": false, "required": [] }
- checkinpatronholdunshippeditem(servicePointId, itemBarcode, id_)
receive un-shipped/unannounced item for patron hold transaction
POST /inn-reach/transactions/{id}/receive-unshipped-item/{servicePointId}/{itemBarcode}- Parameters
servicePointId (str) – (format: uuid)
itemBarcode (str) – Barcode of the item
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Receive Item for Patron Hold Transaction", "type": "object", "properties": { "transaction": { "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }, "folioCheckIn": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "description": "Success response for checking in an item at a service point", "properties": { "loan": { "description": "Loan affected by the check in (may be none, if a receiving check in)", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Loan", "properties": { "id": { "description": "Unique ID (generated UUID) of the loan", "type": "string", "format": "UUID" }, "userId": { "description": "ID of the patron the item was lent to. Required for open loans, not required for closed loans (for anonymization).", "type": "string", "format": "UUID" }, "borrower": { "description": "Additional information about the borrower of the item, taken from the user referred to by the userId", "readonly": true, "type": "object", "properties": { "firstName": { "description": "first name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "lastName": { "description": "last name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "middleName": { "description": "middle name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "barcode": { "description": "barcode used to identify the borrower (read only, defined by the server)", "type": "string", "readonly": true } }, "additionalProperties": false }, "proxyUserId": { "description": "ID of the user representing a proxy for the patron", "type": "string", "format": "UUID" }, "itemId": { "description": "ID of the item lent to the patron", "type": "string", "format": "UUID" }, "loanPolicyId": { "description": "ID of last policy used in relation to this loan", "type": "string", "format": "UUID" }, "loanPolicy": { "description": "Additional information about the loan policy of the item, taken from the loan loanPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "overdueFinePolicyId": { "description": "ID of last overdue fine policy used in relation to this loan", "type": "string", "format": "UUID" }, "overdueFinePolicy": { "description": "Additional information about the overdue fine policy of the item, taken from the loan overdueFinePolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last overdue fine policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "lostItemPolicyId": { "description": "ID of last lost item policy used in relation to this loan", "type": "string", "format": "UUID" }, "lostItemPolicy": { "description": "Additional information about the lost item policy of the item, taken from the loan lostItemPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last lost item policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "item": { "description": "Additional information about the item", "type": "object", "readonly": true, "properties": { "id": { "description": "ID of the item", "type": "string", "format": "UUID", "readonly": true }, "title": { "description": "The title of the item lent to the patron", "type": "string", "readonly": true }, "callNumber": { "description": "Deprecated call number from the holdings record, use callNumberComponents.callNumber instead", "type": "string", "readonly": true }, "materialType": { "description": "The material type from the item record", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the material type", "type": "string", "readonly": true } }, "additionalProperties": false }, "contributors": { "description": "Contributors from the instance record", "type": "array", "readonly": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the contributor", "type": "string", "readonly": true } }, "additionalProperties": false } }, "holdingsRecordId": { "description": "The ID of the holdings for the item", "type": "string", "format": "UUID", "readonly": true }, "instanceId": { "description": "The ID of the instance for the item", "type": "string", "format": "UUID", "readonly": true }, "barcode": { "description": "The barcode of the item", "type": "string", "readonly": true }, "location": { "description": "The effective location of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "The name of the location", "type": "string", "readonly": true } } }, "status": { "description": "Overall status of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the item status", "type": "string", "readonly": true }, "date": { "type": "string", "description": "Date time when status was last changed", "format": "date-time", "readonly": true } }, "additionalProperties": false }, "inTransitDestinationServicePointId": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "string", "format": "UUID", "readonly": true }, "inTransitDestinationServicePoint": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true } } }, "enumeration": { "description": "Item`s enumeration", "type": "string", "readonly": true }, "chronology": { "description": "Item`s chronology", "type": "string", "readonly": true }, "volume": { "description": "Item`s volume", "type": "string", "readonly": true }, "callNumberComponents": { "description": "Elements of a full call number", "readonly": true, "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "callNumber": { "type": "string", "description": "Call number for item", "readonly": true }, "prefix": { "description": "Call number prefix for item", "type": "string", "readonly": true }, "suffix": { "description": "Call number suffix for item", "type": "string", "readonly": true } } } }, "additionalProperties": false }, "itemEffectiveLocationIdAtCheckOut": { "description": "The effective location, at the time of checkout, of the item loaned to the patron.", "type": "string", "format": "UUID" }, "status": { "description": "Overall status of the loan", "type": "object", "properties": { "name": { "description": "Name of the status (currently can be any value, values commonly used are Open and Closed)", "type": "string" } } }, "loanDate": { "description": "Date and time when the loan began", "type": "string", "format": "date-time" }, "dueDate": { "description": "Date and time when the item is due to be returned", "type": "string", "format": "date-time" }, "returnDate": { "description": "Date and time when the item was returned", "type": "string", "format": "date-time" }, "systemReturnDate": { "description": "Date and time when return was processed", "type": "string", "format": "date-time" }, "action": { "description": "Last action performed on a loan (currently can be any value, values commonly used are checkedout and checkedin)", "type": "string" }, "renewalCount": { "description": "Count of how many times a loan has been renewed (incremented by the client)", "type": "integer", "minimum": 0 }, "checkoutServicePointId": { "description": "ID of the Service Point where the last checkout occured", "type": "string", "format": "UUID" }, "checkinServicePointId": { "description": "ID of the Service Point where the last checkin occured", "type": "string", "format": "UUID" }, "checkoutServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "The unique name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "checkinServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "patronGroupAtCheckout": { "description": "Patron Group at checkout", "type": "object", "properties": { "id": { "description": "Unique ID (generated UUID) of the patron group", "type": "string", "format": "UUID", "readonly": true }, "name": { "description": "Patron group name", "type": "string", "readonly": true } }, "additionalProperties": false }, "feesAndFines": { "description": "Fees and fines associated with loans", "type": "object", "properties": { "amountRemainingToPay": { "type": "number", "description": "Total remaining amount due on fees and fines for the loan (read only, defined by the server)", "readonly": true } }, "additionalProperties": false }, "declaredLostDate": { "description": "Date and time the item was declared lost during this loan", "type": "string", "format": "date-time" }, "metadata": { "description": "Metadata about creation and changes to loan, provided by the server (client should not provide)", "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "title": "Metadata Schema", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "format": "UUID" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "format": "UUID" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "required": [ "itemId", "loanDate", "action" ] }, "item": { "description": "Additional information about the item", "type": "object", "properties": { "id": { "description": "ID of the item", "type": "string" }, "title": { "description": "The title of the item lent to the patron", "type": "string" }, "callNumber": { "description": "The call number from the holdings record", "type": "string" }, "materialType": { "description": "The material type from the item record", "type": "object", "properties": { "name": { "description": "Name of the material type", "type": "string" } }, "additionalProperties": false }, "contributors": { "description": "Contributors from the instance record", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "Name of the contributor", "type": "string" } }, "additionalProperties": false } }, "holdingsRecordId": { "description": "The ID of the holdings for the item", "type": "string" }, "instanceId": { "description": "The ID of the instance for the item", "type": "string" }, "barcode": { "description": "The barcode of the item", "type": "string" }, "location": { "description": "The effective location of the item", "type": "object", "properties": { "name": { "description": "The name of the location", "type": "string" } }, "additionalProperties": false }, "status": { "description": "Overall status of the item", "type": "object", "properties": { "name": { "description": "Name of the item status", "type": "string" }, "date": { "type": "string", "description": "Date time when status was last changed", "format": "date-time" } }, "additionalProperties": false }, "enumeration": { "description": "Item`s enumeration", "type": "string" }, "chronology": { "description": "Chronology is the descriptive information for the dating scheme of a serial.", "type": "string" }, "volume": { "description": "Volume is intended for monographs when a multipart monograph (e.g. a biography of George Bernard Shaw in three volumes).", "type": "string" }, "inTransitDestinationServicePointId": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "string", "format": "UUID" }, "inTransitDestinationServicePoint": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "object", "properties": { "name": { "description": "Name of the service point", "type": "string" } } } }, "additionalProperties": false }, "staffSlipContext": { "description": "Context for staff slip tokens", "type": "object" }, "inHouseUse": { "type": "boolean", "description": "Defines whether the current check-in operation considered as in-house use or not." } }, "additionalProperties": false }, "barcodeAugmented": { "description": "indicates if the FOLIO item's barcode was augmented to avoid duplicate barcode collision (item agency code appended)", "type": "boolean" } }, "additionalProperties": false, "required": [] }
- checkoutitemholditem(itemBarcode, servicePointId)
checks out an item from the owning site to the borrowing site for an Item Hold transaction
PUT /inn-reach/transactions/{itemBarcode}/check-out-item/{servicePointId}- Parameters
itemBarcode (str) – Barcode of the item
servicePointId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Check out to borrowing site for Item Hold Transaction", "type": "object", "properties": { "transaction": { "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }, "folioCheckOut": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Loan", "description": "Links the item with the patron and applies certain conditions based on policies", "properties": { "id": { "description": "Unique ID (generated UUID) of the loan", "type": "string", "format": "UUID" }, "userId": { "description": "ID of the patron the item was lent to. Required for open loans, not required for closed loans (for anonymization).", "type": "string", "format": "UUID" }, "borrower": { "description": "Additional information about the borrower of the item, taken from the user referred to by the userId", "readonly": true, "type": "object", "properties": { "firstName": { "description": "first name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "lastName": { "description": "last name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "middleName": { "description": "middle name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "barcode": { "description": "barcode used to identify the borrower (read only, defined by the server)", "type": "string", "readonly": true } }, "additionalProperties": false }, "proxyUserId": { "description": "ID of the user representing a proxy for the patron", "type": "string", "format": "UUID" }, "itemId": { "description": "ID of the item lent to the patron", "type": "string", "format": "UUID" }, "loanPolicyId": { "description": "ID of last policy used in relation to this loan", "type": "string", "format": "UUID" }, "loanPolicy": { "description": "Additional information about the loan policy of the item, taken from the loan loanPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "overdueFinePolicyId": { "description": "ID of last overdue fine policy used in relation to this loan", "type": "string", "format": "UUID" }, "overdueFinePolicy": { "description": "Additional information about the overdue fine policy of the item, taken from the loan overdueFinePolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last overdue fine policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "lostItemPolicyId": { "description": "ID of last lost item policy used in relation to this loan", "type": "string", "format": "UUID" }, "lostItemPolicy": { "description": "Additional information about the lost item policy of the item, taken from the loan lostItemPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last lost item policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "item": { "description": "Additional information about the item", "type": "object", "readonly": true, "properties": { "id": { "description": "ID of the item", "type": "string", "readonly": true, "format": "UUID" }, "title": { "description": "The title of the item lent to the patron", "type": "string", "readonly": true }, "callNumber": { "description": "Deprecated call number from the holdings record, use callNumberComponents.callNumber instead", "type": "string", "readonly": true }, "materialType": { "description": "The material type from the item record", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the material type", "type": "string", "readonly": true } }, "additionalProperties": false }, "contributors": { "description": "Contributors from the instance record", "type": "array", "readonly": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the contributor", "type": "string", "readonly": true } }, "additionalProperties": false } }, "holdingsRecordId": { "description": "The ID of the holdings for the item", "type": "string", "readonly": true, "format": "UUID" }, "instanceId": { "description": "The ID of the instance for the item", "type": "string", "readonly": true, "format": "UUID" }, "barcode": { "description": "The barcode of the item", "type": "string", "readonly": true }, "location": { "description": "The effective location of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "The name of the location", "type": "string", "readonly": true } } }, "status": { "description": "Overall status of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the item status", "type": "string", "readonly": true }, "date": { "type": "string", "description": "Date time when status was last changed", "format": "date-time", "readonly": true } }, "additionalProperties": false }, "inTransitDestinationServicePointId": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "string", "readonly": true, "format": "UUID" }, "inTransitDestinationServicePoint": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true } } }, "enumeration": { "description": "Item`s enumeration", "type": "string", "readonly": true }, "chronology": { "description": "Item`s chronology", "type": "string", "readonly": true }, "volume": { "description": "Item`s volume", "type": "string", "readonly": true }, "callNumberComponents": { "description": "Elements of a full call number", "readonly": true, "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "callNumber": { "type": "string", "description": "Call number for item", "readonly": true }, "prefix": { "description": "Call number prefix for item", "type": "string", "readonly": true }, "suffix": { "description": "Call number suffix for item", "type": "string", "readonly": true } } } }, "additionalProperties": false }, "itemEffectiveLocationIdAtCheckOut": { "description": "The effective location, at the time of checkout, of the item loaned to the patron.", "type": "string", "format": "UUID" }, "status": { "description": "Overall status of the loan", "type": "object", "properties": { "name": { "description": "Name of the status (currently can be any value, values commonly used are Open and Closed)", "type": "string" } } }, "loanDate": { "description": "Date and time when the loan began", "type": "string", "format": "date-time" }, "dueDate": { "description": "Date and time when the item is due to be returned", "type": "string", "format": "date-time" }, "returnDate": { "description": "Date and time when the item was returned", "type": "string", "format": "date-time" }, "systemReturnDate": { "description": "Date and time when return was processed", "type": "string", "format": "date-time" }, "action": { "description": "Last action performed on a loan (currently can be any value, values commonly used are checkedout and checkedin)", "type": "string" }, "renewalCount": { "description": "Count of how many times a loan has been renewed (incremented by the client)", "type": "integer", "minimum": 0 }, "checkoutServicePointId": { "description": "ID of the Service Point where the last checkout occured", "type": "string", "format": "UUID" }, "checkinServicePointId": { "description": "ID of the Service Point where the last checkin occured", "type": "string", "format": "UUID" }, "checkoutServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "The unique name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "checkinServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "patronGroupAtCheckout": { "description": "Patron Group at checkout", "type": "object", "properties": { "id": { "description": "Unique ID (generated UUID) of the patron group", "type": "string", "readonly": true, "format": "UUID" }, "name": { "description": "Patron group name", "type": "string", "readonly": true } }, "additionalProperties": false }, "feesAndFines": { "description": "Fees and fines associated with loans", "type": "object", "properties": { "amountRemainingToPay": { "type": "number", "description": "Total remaining amount due on fees and fines for the loan (read only, defined by the server)", "readonly": true } }, "additionalProperties": false }, "declaredLostDate": { "description": "Date and time the item was declared lost during this loan", "type": "string", "format": "date-time" }, "metadata": { "description": "Metadata about creation and changes to loan, provided by the server (client should not provide)", "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "title": "Metadata Schema", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "required": [ "itemId", "loanDate", "action" ] } }, "additionalProperties": false, "required": [] }
- checkoutlocalholditem(servicePointId, id_)
Checks out Local Hold item to requesting patron
POST /inn-reach/transactions/{id}/localhold/check-out-item/{servicePointId}- Parameters
servicePointId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Check out to borrowing site for Item Hold Transaction", "type": "object", "properties": { "transaction": { "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }, "folioCheckOut": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Loan", "description": "Links the item with the patron and applies certain conditions based on policies", "properties": { "id": { "description": "Unique ID (generated UUID) of the loan", "type": "string", "format": "UUID" }, "userId": { "description": "ID of the patron the item was lent to. Required for open loans, not required for closed loans (for anonymization).", "type": "string", "format": "UUID" }, "borrower": { "description": "Additional information about the borrower of the item, taken from the user referred to by the userId", "readonly": true, "type": "object", "properties": { "firstName": { "description": "first name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "lastName": { "description": "last name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "middleName": { "description": "middle name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "barcode": { "description": "barcode used to identify the borrower (read only, defined by the server)", "type": "string", "readonly": true } }, "additionalProperties": false }, "proxyUserId": { "description": "ID of the user representing a proxy for the patron", "type": "string", "format": "UUID" }, "itemId": { "description": "ID of the item lent to the patron", "type": "string", "format": "UUID" }, "loanPolicyId": { "description": "ID of last policy used in relation to this loan", "type": "string", "format": "UUID" }, "loanPolicy": { "description": "Additional information about the loan policy of the item, taken from the loan loanPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "overdueFinePolicyId": { "description": "ID of last overdue fine policy used in relation to this loan", "type": "string", "format": "UUID" }, "overdueFinePolicy": { "description": "Additional information about the overdue fine policy of the item, taken from the loan overdueFinePolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last overdue fine policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "lostItemPolicyId": { "description": "ID of last lost item policy used in relation to this loan", "type": "string", "format": "UUID" }, "lostItemPolicy": { "description": "Additional information about the lost item policy of the item, taken from the loan lostItemPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last lost item policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "item": { "description": "Additional information about the item", "type": "object", "readonly": true, "properties": { "id": { "description": "ID of the item", "type": "string", "readonly": true, "format": "UUID" }, "title": { "description": "The title of the item lent to the patron", "type": "string", "readonly": true }, "callNumber": { "description": "Deprecated call number from the holdings record, use callNumberComponents.callNumber instead", "type": "string", "readonly": true }, "materialType": { "description": "The material type from the item record", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the material type", "type": "string", "readonly": true } }, "additionalProperties": false }, "contributors": { "description": "Contributors from the instance record", "type": "array", "readonly": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the contributor", "type": "string", "readonly": true } }, "additionalProperties": false } }, "holdingsRecordId": { "description": "The ID of the holdings for the item", "type": "string", "readonly": true, "format": "UUID" }, "instanceId": { "description": "The ID of the instance for the item", "type": "string", "readonly": true, "format": "UUID" }, "barcode": { "description": "The barcode of the item", "type": "string", "readonly": true }, "location": { "description": "The effective location of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "The name of the location", "type": "string", "readonly": true } } }, "status": { "description": "Overall status of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the item status", "type": "string", "readonly": true }, "date": { "type": "string", "description": "Date time when status was last changed", "format": "date-time", "readonly": true } }, "additionalProperties": false }, "inTransitDestinationServicePointId": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "string", "readonly": true, "format": "UUID" }, "inTransitDestinationServicePoint": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true } } }, "enumeration": { "description": "Item`s enumeration", "type": "string", "readonly": true }, "chronology": { "description": "Item`s chronology", "type": "string", "readonly": true }, "volume": { "description": "Item`s volume", "type": "string", "readonly": true }, "callNumberComponents": { "description": "Elements of a full call number", "readonly": true, "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "callNumber": { "type": "string", "description": "Call number for item", "readonly": true }, "prefix": { "description": "Call number prefix for item", "type": "string", "readonly": true }, "suffix": { "description": "Call number suffix for item", "type": "string", "readonly": true } } } }, "additionalProperties": false }, "itemEffectiveLocationIdAtCheckOut": { "description": "The effective location, at the time of checkout, of the item loaned to the patron.", "type": "string", "format": "UUID" }, "status": { "description": "Overall status of the loan", "type": "object", "properties": { "name": { "description": "Name of the status (currently can be any value, values commonly used are Open and Closed)", "type": "string" } } }, "loanDate": { "description": "Date and time when the loan began", "type": "string", "format": "date-time" }, "dueDate": { "description": "Date and time when the item is due to be returned", "type": "string", "format": "date-time" }, "returnDate": { "description": "Date and time when the item was returned", "type": "string", "format": "date-time" }, "systemReturnDate": { "description": "Date and time when return was processed", "type": "string", "format": "date-time" }, "action": { "description": "Last action performed on a loan (currently can be any value, values commonly used are checkedout and checkedin)", "type": "string" }, "renewalCount": { "description": "Count of how many times a loan has been renewed (incremented by the client)", "type": "integer", "minimum": 0 }, "checkoutServicePointId": { "description": "ID of the Service Point where the last checkout occured", "type": "string", "format": "UUID" }, "checkinServicePointId": { "description": "ID of the Service Point where the last checkin occured", "type": "string", "format": "UUID" }, "checkoutServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "The unique name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "checkinServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "patronGroupAtCheckout": { "description": "Patron Group at checkout", "type": "object", "properties": { "id": { "description": "Unique ID (generated UUID) of the patron group", "type": "string", "readonly": true, "format": "UUID" }, "name": { "description": "Patron group name", "type": "string", "readonly": true } }, "additionalProperties": false }, "feesAndFines": { "description": "Fees and fines associated with loans", "type": "object", "properties": { "amountRemainingToPay": { "type": "number", "description": "Total remaining amount due on fees and fines for the loan (read only, defined by the server)", "readonly": true } }, "additionalProperties": false }, "declaredLostDate": { "description": "Date and time the item was declared lost during this loan", "type": "string", "format": "date-time" }, "metadata": { "description": "Metadata about creation and changes to loan, provided by the server (client should not provide)", "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "title": "Metadata Schema", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "required": [ "itemId", "loanDate", "action" ] } }, "additionalProperties": false, "required": [] }
- checkoutpatronholditem(servicePointId, id_)
Checks out to requesting patron
POST /inn-reach/transactions/{id}/patronhold/check-out-item/{servicePointId}- Parameters
servicePointId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Check out to borrowing site for Item Hold Transaction", "type": "object", "properties": { "transaction": { "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }, "folioCheckOut": { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "title": "Loan", "description": "Links the item with the patron and applies certain conditions based on policies", "properties": { "id": { "description": "Unique ID (generated UUID) of the loan", "type": "string", "format": "UUID" }, "userId": { "description": "ID of the patron the item was lent to. Required for open loans, not required for closed loans (for anonymization).", "type": "string", "format": "UUID" }, "borrower": { "description": "Additional information about the borrower of the item, taken from the user referred to by the userId", "readonly": true, "type": "object", "properties": { "firstName": { "description": "first name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "lastName": { "description": "last name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "middleName": { "description": "middle name of the borrower (read only, defined by the server)", "type": "string", "readonly": true }, "barcode": { "description": "barcode used to identify the borrower (read only, defined by the server)", "type": "string", "readonly": true } }, "additionalProperties": false }, "proxyUserId": { "description": "ID of the user representing a proxy for the patron", "type": "string", "format": "UUID" }, "itemId": { "description": "ID of the item lent to the patron", "type": "string", "format": "UUID" }, "loanPolicyId": { "description": "ID of last policy used in relation to this loan", "type": "string", "format": "UUID" }, "loanPolicy": { "description": "Additional information about the loan policy of the item, taken from the loan loanPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "overdueFinePolicyId": { "description": "ID of last overdue fine policy used in relation to this loan", "type": "string", "format": "UUID" }, "overdueFinePolicy": { "description": "Additional information about the overdue fine policy of the item, taken from the loan overdueFinePolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last overdue fine policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "lostItemPolicyId": { "description": "ID of last lost item policy used in relation to this loan", "type": "string", "format": "UUID" }, "lostItemPolicy": { "description": "Additional information about the lost item policy of the item, taken from the loan lostItemPolicyId", "readonly": true, "type": "object", "properties": { "name": { "readonly": true, "description": "Name of last lost item policy used in relation to this loan (read only, defined by the server)", "type": "string" } } }, "item": { "description": "Additional information about the item", "type": "object", "readonly": true, "properties": { "id": { "description": "ID of the item", "type": "string", "readonly": true, "format": "UUID" }, "title": { "description": "The title of the item lent to the patron", "type": "string", "readonly": true }, "callNumber": { "description": "Deprecated call number from the holdings record, use callNumberComponents.callNumber instead", "type": "string", "readonly": true }, "materialType": { "description": "The material type from the item record", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the material type", "type": "string", "readonly": true } }, "additionalProperties": false }, "contributors": { "description": "Contributors from the instance record", "type": "array", "readonly": true, "items": { "type": "object", "properties": { "name": { "description": "Name of the contributor", "type": "string", "readonly": true } }, "additionalProperties": false } }, "holdingsRecordId": { "description": "The ID of the holdings for the item", "type": "string", "readonly": true, "format": "UUID" }, "instanceId": { "description": "The ID of the instance for the item", "type": "string", "readonly": true, "format": "UUID" }, "barcode": { "description": "The barcode of the item", "type": "string", "readonly": true }, "location": { "description": "The effective location of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "The name of the location", "type": "string", "readonly": true } } }, "status": { "description": "Overall status of the item", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the item status", "type": "string", "readonly": true }, "date": { "type": "string", "description": "Date time when status was last changed", "format": "date-time", "readonly": true } }, "additionalProperties": false }, "inTransitDestinationServicePointId": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "string", "readonly": true, "format": "UUID" }, "inTransitDestinationServicePoint": { "description": "Service point an item is intended to be transited to (should only be present when in transit)", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true } } }, "enumeration": { "description": "Item`s enumeration", "type": "string", "readonly": true }, "chronology": { "description": "Item`s chronology", "type": "string", "readonly": true }, "volume": { "description": "Item`s volume", "type": "string", "readonly": true }, "callNumberComponents": { "description": "Elements of a full call number", "readonly": true, "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "callNumber": { "type": "string", "description": "Call number for item", "readonly": true }, "prefix": { "description": "Call number prefix for item", "type": "string", "readonly": true }, "suffix": { "description": "Call number suffix for item", "type": "string", "readonly": true } } } }, "additionalProperties": false }, "itemEffectiveLocationIdAtCheckOut": { "description": "The effective location, at the time of checkout, of the item loaned to the patron.", "type": "string", "format": "UUID" }, "status": { "description": "Overall status of the loan", "type": "object", "properties": { "name": { "description": "Name of the status (currently can be any value, values commonly used are Open and Closed)", "type": "string" } } }, "loanDate": { "description": "Date and time when the loan began", "type": "string", "format": "date-time" }, "dueDate": { "description": "Date and time when the item is due to be returned", "type": "string", "format": "date-time" }, "returnDate": { "description": "Date and time when the item was returned", "type": "string", "format": "date-time" }, "systemReturnDate": { "description": "Date and time when return was processed", "type": "string", "format": "date-time" }, "action": { "description": "Last action performed on a loan (currently can be any value, values commonly used are checkedout and checkedin)", "type": "string" }, "renewalCount": { "description": "Count of how many times a loan has been renewed (incremented by the client)", "type": "integer", "minimum": 0 }, "checkoutServicePointId": { "description": "ID of the Service Point where the last checkout occured", "type": "string", "format": "UUID" }, "checkinServicePointId": { "description": "ID of the Service Point where the last checkin occured", "type": "string", "format": "UUID" }, "checkoutServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "The unique name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "checkinServicePoint": { "description": "The Service Point where the last checkout occurred", "type": "object", "readonly": true, "properties": { "name": { "description": "Name of the service point", "type": "string", "readonly": true }, "code": { "description": "The short code for the service point", "type": "string", "readonly": true }, "discoveryDisplayName": { "description": "The human readable name", "type": "string", "readonly": true }, "shelvingLagTime": { "description": "The time to shelving", "type": "integer", "readonly": true }, "pickupLocation": { "description": "Is this a pickup location", "type": "boolean", "readonly": true } } }, "patronGroupAtCheckout": { "description": "Patron Group at checkout", "type": "object", "properties": { "id": { "description": "Unique ID (generated UUID) of the patron group", "type": "string", "readonly": true, "format": "UUID" }, "name": { "description": "Patron group name", "type": "string", "readonly": true } }, "additionalProperties": false }, "feesAndFines": { "description": "Fees and fines associated with loans", "type": "object", "properties": { "amountRemainingToPay": { "type": "number", "description": "Total remaining amount due on fees and fines for the loan (read only, defined by the server)", "readonly": true } }, "additionalProperties": false }, "declaredLostDate": { "description": "Date and time the item was declared lost during this loan", "type": "string", "format": "date-time" }, "metadata": { "description": "Metadata about creation and changes to loan, provided by the server (client should not provide)", "type": "object", "$schema": "http://json-schema.org/draft-04/schema#", "title": "Metadata Schema", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "required": [ "itemId", "loanDate", "action" ] } }, "additionalProperties": false, "required": [] }
- claimsreturned(trackingId, centralCode, claimsItemReturnedDTO)
Borrower claims item returned
PUT /inn-reach/d2ir/circ/claimsreturned/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
claimsItemReturnedDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Borrower claims item returned", "type": "object", "properties": { "claimsReturnedDate": { "description": "Claims returned date (date of -1 indicates date unknown)", "type": "integer" } }, "additionalProperties": false, "required": [ "claimsReturnedDate" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- createinnreachtransactionitemhold(trackingId, centralCode, transactionHoldDTO)
Originates an item hold at the owning site
POST /inn-reach/d2ir/circ/itemhold/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
transactionHoldDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during creation of transaction record
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- createlocalhold(trackingId, centralCode, localHoldDTO)
Create Local Hold - Central server to owning site when a local patron of that site requests an item through central.
PUT /inn-reach/d2ir/circ/localhold/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
localHoldDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Patron hold", "type": "object", "properties": { "pickupLocation": { "description": "Pickup location", "type": "string" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Item title", "type": "string", "maxLength": 256 }, "author": { "description": "Author", "type": "string", "maxLength": 256 }, "callNumber": { "description": "Call number", "type": "string", "maxLength": 256 }, "needBefore": { "description": "Need before time", "type": "integer" } }, "additionalProperties": false, "required": [ "pickupLocation", "centralItemType", "centralPatronType", "patronName" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- finalcheckin(trackingId, centralCode, baseCircRequestDTO)
Indicating that a returned item has been received by its owning site. This is a terminating transaction.
PUT /inn-reach/d2ir/circ/finalcheckin/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
baseCircRequestDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach Circulation Common Put Request Data", "type": "object", "properties": { "transactionTime": { "description": "Transaction time", "type": "integer" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "pattern": "[a-z,0-9]{5}" }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "pattern": "[a-z,0-9]{5}" }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" } }, "additionalProperties": false, "required": [ "transactionTime", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- finalcheckinitemhold(servicePointId, id_)
Final check-in of an item loaned through INN-Reach
POST /inn-reach/transactions/{id}/itemhold/finalcheckin/{servicePointId}- Parameters
servicePointId (str) – (format: uuid)
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- getalltransactions(**kwargs)
Get a list of transactions for the given central server
GET /inn-reach/transactions- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
parameters (str) – Query parameters to filter transactions.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request, e.g. malformed query parameter.
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach Transactions collection", "type": "object", "properties": { "totalRecords": { "description": "Total records", "type": "integer" }, "transactions": { "description": "List of INN-Reach Transactions", "type": "array", "items": { "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] } } }, "additionalProperties": false, "required": [ "transactions" ] }
- getbibrecord(bibId, centralCode)
Handles D2IR request from central server for an already-contributed Bib record.
POST /inn-reach/d2ir/getbibrecord/{bibId}/{centralCode}- Parameters
bibId (str) – 32-character, alphanumeric id corresponding to a FOLIO instance record HRID
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "innReachResponseDTO.json" } ], "description": "D2IR Bib info response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "bibInfo": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR Bib info", "type": "object", "properties": { "bibId": { "type": "string", "description": "32-character, alphanumeric id corresponding to a FOLIO instance record HRID", "maxLength": 32, "minLength": 32 }, "marc21BibFormat": { "type": "string", "description": "Currently supports ISO2709", "default": "ISO2709" }, "marc21BibData": { "type": "string", "description": "Base 64 encoded MARC data" }, "titleHoldCount": { "type": "integer", "description": "Number of title level holds - 0 (title level holds not currently supported in FOLIO)", "default": 0 }, "itemCount": { "type": "integer", "description": "Number of items linked to this bib (max 99, count of items associated with the FOLIO instance record that are contributed)", "default": 0 }, "suppress": { "type": "string", "description": "ASCII y, n, or g; g means display the resource in the discovery layer as having been provided by the consortium, not by the individual site.", "default": "n" } }, "additionalProperties": false, "required": [ "bibId", "marc21BibFormat", "marc21BibData" ] } }, "additionalProperties": false, "required": [ "bibInfo" ] }
- getcentralserveragencies()
Get a combined list of agencies available from all configured central servers
GET /inn-reach/central-servers/agencies- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Agency collection from all configured central servers", "type": "object", "properties": { "totalRecords": { "type": "integer" }, "centralServerAgencies": { "description": "List of agencies per central server", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Central server agencies", "type": "object", "properties": { "centralServerId": { "description": "Central server id", "type": "string", "format": "uuid" }, "centralServerCode": { "description": "Central server code", "type": "string", "maxLength": 5 }, "agencies": { "description": "List of agencies for this central server", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Agency details", "type": "object", "properties": { "agencyCode": { "description": "Agency code", "type": "string", "maxLength": 5 }, "description": { "description": "Agency description", "type": "string", "maxLength": 128 } }, "additionalProperties": false, "required": [ "agencyCode", "description" ] } } }, "additionalProperties": false, "required": [ "centralServerId", "centralServerCode", "agencies" ] } } }, "required": [ "centralServerAgencies" ], "additionalProperties": false }
- getcentralserveritemtypes()
Get a combined list of item types available from all configured central servers
GET /inn-reach/central-servers/item-types- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Item types collection from all configured central servers", "type": "object", "properties": { "centralServerItemTypes": { "description": "List of item types per central server", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Central server item types", "type": "object", "properties": { "centralServerId": { "description": "Central server id", "type": "string", "format": "uuid" }, "centralServerCode": { "description": "Central server code", "type": "string", "maxLength": 5 }, "itemTypes": { "description": "List of item types for this central server", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Item type details", "type": "object", "properties": { "centralItemType": { "description": "Item type", "type": "integer" }, "description": { "description": "Item type description", "type": "string" } }, "additionalProperties": false, "required": [ "centralItemType", "description" ] } } }, "additionalProperties": false, "required": [ "centralServerId", "centralServerCode", "itemTypes" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "centralServerItemTypes" ] }
- getcentralserverpatrontypes()
Get a combined list of patron types available from all configured central servers
GET /inn-reach/central-servers/patron-types- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Patron types collection from all configured central servers", "type": "object", "properties": { "centralServerPatronTypes": { "description": "List of patron types per central server", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Central server patron types", "type": "object", "properties": { "centralServerId": { "description": "Central server id", "type": "string", "format": "uuid" }, "centralServerCode": { "description": "Central server code", "type": "string", "maxLength": 5 }, "patronTypes": { "description": "List of patron types for this central server", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Patron type details", "type": "object", "properties": { "centralPatronType": { "description": "Patron type", "type": "integer" }, "description": { "description": "Patron type description", "type": "string" } }, "additionalProperties": false, "required": [ "centralPatronType", "description" ] } } }, "additionalProperties": false, "required": [ "centralServerId", "centralServerCode", "patronTypes" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "centralServerPatronTypes" ] }
- getinnreachtransaction(id_)
get inn-reach transaction by id
GET /inn-reach/transactions/{id}- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }
- getpagingslips(servicePointId)
Get a list of available tokens for INN-Reach paging slips
GET /inn-reach/paging-slips/{servicePointId}- Parameters
servicePointId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "A collection of paging slips", "type": "object", "properties": { "pagingSlips": { "description": "Collection of current paging slips", "id": "pagingSlips", "type": "array", "items": { "title": "Paging slip", "description": "Paging slip representation of item, request and requester", "type": "object", "properties": { "innReachTransaction": { "description": "Paging slip representation of an INN-Reach transaction", "type": "object", "properties": { "patronName": { "description": "Patron name", "type": "string" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string" }, "patronAgencyDescription": { "description": "Patron agency description", "type": "string" }, "patronTypeCode": { "description": "Patron type", "type": "integer" }, "patronTypeDescription": { "description": "Patron type description", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "centralServerId": { "description": "UUID of the central server configuration", "type": "string", "format": "UUID" }, "localServerCode": { "description": "Unique code that identifies the local server", "type": "string" }, "itemAgencyCode": { "description": "Item agency code", "type": "string" }, "itemAgencyDescription": { "description": "Item agency description", "type": "string" }, "pickupLocationCode": { "description": "Pickup location code", "type": "string" }, "pickupLocationPrintName": { "description": "Pickup location print name", "type": "string" }, "pickupLocationDeliveryStop": { "description": "Pickup location", "type": "string" } } }, "item": { "description": "Paging slip representation of an item", "type": "object", "properties": { "effectiveLocationFolioName": { "description": "Effective location FOLIO name", "type": "string" }, "title": { "description": "Primary title (or label) associated with an item", "type": "string" }, "barcode": { "description": "Unique inventory control number for physical resources, used largely for circulation purposes", "type": "string" }, "author": { "description": "Author", "type": "string" }, "effectiveCallNumber": { "type": "string", "description": "Effective call number, an identifier assigned to the item or its holding" }, "shelvingOrder": { "type": "string", "description": "A system generated normalization of the call number that allows for call number sorting in reports and search results" }, "hrid": { "type": "string", "description": "The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID" } }, "additionalProperties": false }, "slip": { "type": "object", "description": "Slip info", "properties": { "name": { "description": "Slip name", "type": "string" } } } }, "additionalProperties": false } }, "totalRecords": { "description": "Total number of paging slips", "type": "integer", "default": 0 } }, "additionalProperties": false, "required": [ "pagingSlips", "totalRecords" ] }
- itemintransit(trackingId, centralCode, baseCircRequestDTO)
Receives message from central server to owning site indicating that a loaned item is being returned after being loaned to the borrowing patron.
PUT /inn-reach/d2ir/circ/intransit/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
baseCircRequestDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach Circulation Common Put Request Data", "type": "object", "properties": { "transactionTime": { "description": "Transaction time", "type": "integer" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "pattern": "[a-z,0-9]{5}" }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "pattern": "[a-z,0-9]{5}" }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" } }, "additionalProperties": false, "required": [ "transactionTime", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- itemreceived(trackingId, centralCode, itemReceivedDTO)
Shipped item has been received
PUT /inn-reach/d2ir/circ/itemreceived/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
itemReceivedDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Item received", "type": "object", "properties": { "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "title": { "description": "Item title", "type": "string", "maxLength": 256 }, "author": { "description": "Author", "type": "string", "maxLength": 256 }, "itemBarcode": { "description": "Item barcode", "type": "string" }, "callNumber": { "description": "Call number", "type": "string", "maxLength": 256 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 } }, "additionalProperties": false, "required": [ "centralItemType", "centralPatronType" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- itemshipped(trackingId, centralCode, itemShippedDTO)
Process shipped item
PUT /inn-reach/d2ir/circ/itemshipped/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
itemShippedDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Item shipped", "type": "object", "properties": { "pickupLocation": { "description": "Pickup location", "type": "string" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "itemBarcode": { "description": "Item barcode", "type": "string" }, "title": { "description": "Item title", "type": "string", "maxLength": 256 }, "author": { "description": "Author", "type": "string", "maxLength": 256 }, "callNumber": { "description": "Call number", "type": "string", "maxLength": 256 }, "itemLocation": { "description": "Item location", "type": "string" }, "needBefore": { "description": "Need before time", "type": "integer" } }, "additionalProperties": false, "required": [ "pickupLocation", "centralItemType" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- ownerrenew(trackingId, centralCode, renewLoanDTO)
Owner Renew loan
PUT /inn-reach/d2ir/circ/ownerrenew/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
renewLoanDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Renew loan request", "type": "object", "properties": { "dueDateTime": { "description": "Due date time", "type": "integer" } }, "additionalProperties": false, "required": [ "dueDateTime" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- patronhold(trackingId, centralCode, patronHoldDTO)
Originate a patron hold
POST /inn-reach/d2ir/circ/patronhold/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
patronHoldDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Patron hold", "type": "object", "properties": { "pickupLocation": { "description": "Pickup location", "type": "string" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "title": { "description": "Item title", "type": "string", "maxLength": 256 }, "author": { "description": "Author", "type": "string", "maxLength": 256 }, "callNumber": { "description": "Call number", "type": "string", "maxLength": 256 }, "needBefore": { "description": "Need before time", "type": "integer" } }, "additionalProperties": false, "required": [ "pickupLocation", "centralItemType" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- recall(trackingId, centralCode, recallDTO)
Item has been recalled
PUT /inn-reach/d2ir/circ/recall/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
recallDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Item recalled", "type": "object", "properties": { "dueDateTime": { "description": "Due date time", "type": "integer" } }, "additionalProperties": false, "required": [ "dueDateTime" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- recallitemholdtransaction(id_)
Recall item hold transaction
POST /inn-reach/transactions/{id}/itemhold/recall- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- receiveunshipped(trackingId, centralCode, baseCircRequestDTO)
Report unshipped item received to owning site for item hold
PUT /inn-reach/d2ir/circ/receiveunshipped/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
baseCircRequestDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
Schema
{ "description": "INN-Reach Circulation Common Put Request Data", "type": "object", "properties": { "transactionTime": { "description": "Transaction time", "type": "integer" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "pattern": "[a-z,0-9]{5}" }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "pattern": "[a-z,0-9]{5}" }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" } }, "additionalProperties": false, "required": [ "transactionTime", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- returnpatronholditem(servicePointId, id_)
Returns Patron Hold item
POST /inn-reach/transactions/{id}/patronhold/return-item/{servicePointId}- Parameters
servicePointId (str) – (format: uuid)
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- returnuncirculated(trackingId, centralCode, returnUncirculatedDTO)
Return uncirculated message for item hold
PUT /inn-reach/d2ir/circ/returnuncirculated/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
returnUncirculatedDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "INN-Reach Return Circulation Message Put Request Data", "type": "object", "properties": { "title": { "description": "Item title", "type": "string", "maxLength": 256 }, "author": { "description": "Author", "type": "string" } }, "additionalProperties": false }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- transferitemhold(itemId, id_)
Transfer item hold to another item
POST /inn-reach/transactions/{id}/itemhold/transfer-item/{itemId}- Parameters
itemId (str) – (format: uuid)
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- transferlocalhold(itemId, id_)
Transfer local hold to another item
POST /inn-reach/transactions/{id}/localhold/transfer-item/{itemId}- Parameters
itemId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }
- transferrequest(trackingId, centralCode, transferRequestDTO)
Put transfer request
PUT /inn-reach/d2ir/circ/transferrequest/{trackingId}/{centralCode}- Parameters
trackingId (str) –
centralCode (str) – Unique code that identifies the central server (match against value stored in Central Server settings, used to determine contribution status) (pattern: [a-z,0-9]{3,5})
transferRequestDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – An error occurred during processing the request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "baseCircRequestDTO.json" } ], "description": "D2IR Transfer request", "type": "object", "properties": { "newItemId": { "description": "New item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" } }, "additionalProperties": false, "required": [ "newItemId" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "status": { "description": "Status", "type": "string" }, "reason": { "description": "Reason", "type": "string" }, "errors": { "description": "Errors", "type": "array", "items": { "description": "D2IR error", "type": "object", "properties": { "messages": { "type": "array", "description": "Error messages", "items": { "type": "string" } }, "central": { "type": "string", "description": "Central code" }, "reason": { "type": "string", "description": "Reason" }, "type": { "type": "string", "description": "Error type" }, "rejectedValue": { "description": "Rejected value" }, "name": { "type": "string", "description": "Name of the rejected field" } }, "additionalProperties": false, "required": [ "reason" ] } } }, "additionalProperties": false, "required": [ "status", "reason", "errors" ] }
- updateinnreachtransaction(innReachTransactionDTO, id_)
update inn-reach transaction by id
PUT /inn-reach/transactions/{id}- Parameters
innReachTransactionDTO (dict) – See Schema below.
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach Transaction record", "type": "object", "properties": { "id": { "description": "Transaction id", "type": "string", "format": "UUID" }, "trackingId": { "description": "ID for transaction tracking", "type": "string" }, "centralServerCode": { "description": "Unique code that identifies the central server", "type": "string" }, "state": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction State enum", "description": "Transaction State enum", "type": "string", "additionalProperties": false, "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" ] }, "type": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Transaction Type enum", "description": "Transaction Type enum", "type": "string", "additionalProperties": false, "enum": [ "ITEM", "PATRON", "LOCAL" ] }, "hold": { "description": "INN-Reach Transaction hold record", "type": "object", "properties": { "id": { "description": "Transaction Hold id", "type": "string", "format": "UUID" }, "transactionTime": { "description": "Transaction time", "type": "integer" }, "pickupLocation": { "description": "Pickup location", "type": "string" }, "patronId": { "description": "Patron id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemAgencyCode": { "description": "Item agency code", "type": "string", "minLength": 5, "maxLength": 5 }, "itemId": { "description": "Item id", "type": "string", "pattern": "[a-z,0-9]{1,32}" }, "needBefore": { "description": "Need before time", "type": "integer" }, "dueDateTime": { "description": "Due date time", "type": "integer" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "patronName": { "description": "Patron name", "type": "string" }, "patronHomeLibrary": { "description": "Patron home library", "type": "string" }, "patronPhone": { "description": "Patron phone", "type": "string" }, "title": { "description": "Patron hold title", "type": "string" }, "author": { "description": "Patron hold author", "type": "string" }, "callNumber": { "description": "Patron hold call number", "type": "string" }, "shippedItemBarcode": { "description": "Shipped item barcode", "type": "string" }, "folioInstanceId": { "description": "Folio instance id", "type": "string", "format": "UUID", "readOnly": true }, "folioHoldingId": { "description": "Folio holding id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronId": { "description": "Folio patron id", "type": "string", "format": "UUID", "readOnly": true }, "folioItemId": { "description": "Folio item id", "type": "string", "format": "UUID", "readOnly": true }, "folioRequestId": { "description": "Folio request id", "type": "string", "format": "UUID", "readOnly": true }, "folioLoanId": { "description": "Folio loan id", "type": "string", "format": "UUID", "readOnly": true }, "folioPatronBarcode": { "description": "Folio patron barcode", "type": "string", "readOnly": true }, "folioItemBarcode": { "description": "Folio item barcode", "type": "string", "readOnly": true }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId" ] }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "transactionTime", "pickupLocation", "patronId", "patronAgencyCode", "itemAgencyCode", "itemId", "centralPatronType", "patronName" ] }
- verifypatron(patronInfoRequestDTO)
Handles D2IR request from central server for patron verification.
POST /inn-reach/d2ir/circ/verifypatron- Parameters
patronInfoRequestDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Request parameters for patron verify", "type": "object", "properties": { "patronName": { "description": "Patron name", "type": "string", "maxLength": 128 }, "patronAgencyCode": { "description": "Patron agency code", "type": "string", "maxLength": 128 }, "visiblePatronId": { "description": "User attribute configured by the system to act as their publicId (externalSystemId or barcode)", "type": "string", "maxLength": 32 } }, "additionalProperties": false, "required": [ "visiblePatronId", "patronAgencyCode", "patronName" ] }
{ "$schema": "http://json-schema.org/draft-04/schema#", "allOf": [ { "$ref": "innReachResponseDTO.json" } ], "description": "D2IR Patron info response", "type": "object", "x-implements": "org.folio.innreach.domain.dto.InnReachResponseData", "properties": { "patronInfo": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "D2IR Patron info", "type": "object", "properties": { "patronId": { "type": "string", "description": "32-character, alphanumeric id corresponding to a FOLIO user.id (UUID with no hyphens)", "maxLength": 32 }, "patronAgencyCode": { "type": "string", "description": "5 character lowercase alphanumeric" }, "centralPatronType": { "type": "integer", "description": "0-255" }, "patronExpireDate": { "type": "integer", "format": "int64", "description": "Epoch UNIX time stamp" }, "localLoans": { "type": "integer", "description": "Number of local (within library) loans" }, "nonLocalLoans": { "type": "integer", "description": "Number of non-local (INN-Reach, ILL, etc.) loans" }, "patronName": { "type": "string", "description": "Maximum 128 characters", "maxLength": 128 } }, "additionalProperties": false, "required": [ "patronId", "patronAgencyCode", "centralPatronType", "patronExpireDate", "localLoans", "nonLocalLoans", "patronName" ] }, "requestAllowed": { "type": "boolean", "description": "If the value is false, the patron cannot place a central request (they will be locally blocked)" } }, "additionalProperties": false, "required": [ "patronInfo", "requestAllowed" ] }