foliolib.folio.api.innReach.Circulation

class foliolib.folio.api.innReach.Circulation(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

INN-Reach Circulation API

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`borrowerrenew`(trackingId, centralCode, ...)	Borrower Renew Message for Item Hold
`cancelitemhold`(trackingId, centralCode, ...)	Cancel an item request
`cancelitemholdtransaction`(...)	Cancel item hold transaction with the reason provided
`cancellocalholdtransaction`(...)	Cancel local hold transaction with the reason provided
`cancelpatronhold`(trackingId, centralCode, ...)	Cancel Patron Hold transaction
`cancelpatronholdtransaction`(...)	Cancel patron hold transaction with the reason provided
`checkinpatronholditem`(servicePointId, id_)	receive item for patron hold transaction
`checkinpatronholdunshippeditem`(...)	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
`createinnreachtransactionitemhold`(...)	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.
`getcentralserveragencies`()	Get a combined list of agencies available from all configured central servers
`getcentralserveritemtypes`()	Get a combined list of item types available from all configured central servers
`getcentralserverpatrontypes`()	Get a combined list of patron types available from all configured central servers
`getinnreachtransaction`(id_)	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
`recallitemholdtransaction`(id_)	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
`updateinnreachtransaction`(...)	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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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
OkapiFatalError – 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": {
            "description": "Transaction state",
            "type": "object",
            "$ref": "transactionStateEnum.json"
        },
        "type": {
            "description": "Transaction type",
            "type": "object",
            "$ref": "transactionTypeEnum.json"
        },
        "hold": {
            "description": "Transaction hold",
            "type": "object",
            "$ref": "transactionHoldDTO.json"
        },
        "metadata": {
            "description": "Entity metadata",
            "type": "object",
            "$ref": "metadata.json"
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
            "description": "Transaction state",
            "type": "object",
            "$ref": "transactionStateEnum.json"
        },
        "type": {
            "description": "Transaction type",
            "type": "object",
            "$ref": "transactionTypeEnum.json"
        },
        "hold": {
            "description": "Transaction hold",
            "type": "object",
            "$ref": "transactionHoldDTO.json"
        },
        "metadata": {
            "description": "Entity metadata",
            "type": "object",
            "$ref": "metadata.json"
        }
    },
    "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
OkapiFatalError – Internal server error

Schema

{
    "description": "Receive Item for Patron Hold Transaction",
    "type": "object",
    "properties": {
        "transaction": {
            "description": "updated INN-Reach transaction record",
            "$ref": "innReachTransactionDTO.json"
        },
        "folioCheckIn": {
            "description": "the FOLIO check-in response",
            "$ref": "circulation/checkInResponseDTO.json"
        },
        "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
OkapiFatalError – Internal server error

Schema

{
    "description": "Receive Item for Patron Hold Transaction",
    "type": "object",
    "properties": {
        "transaction": {
            "description": "updated INN-Reach transaction record",
            "$ref": "innReachTransactionDTO.json"
        },
        "folioCheckIn": {
            "description": "the FOLIO check-in response",
            "$ref": "circulation/checkInResponseDTO.json"
        },
        "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
OkapiFatalError – Internal server error

Schema

{
    "description": "Check out to borrowing site for Item Hold Transaction",
    "type": "object",
    "properties": {
        "transaction": {
            "description": "updated INN-Reach transaction record",
            "$ref": "innReachTransactionDTO.json"
        },
        "folioCheckOut": {
            "description": "the FOLIO check-out response",
            "$ref": "circulation/loanDTO.json"
        }
    },
    "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
OkapiFatalError – Internal server error

Schema

{
    "description": "Check out to borrowing site for Item Hold Transaction",
    "type": "object",
    "properties": {
        "transaction": {
            "description": "updated INN-Reach transaction record",
            "$ref": "innReachTransactionDTO.json"
        },
        "folioCheckOut": {
            "description": "the FOLIO check-out response",
            "$ref": "circulation/loanDTO.json"
        }
    },
    "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
OkapiFatalError – Internal server error

Schema

{
    "description": "Check out to borrowing site for Item Hold Transaction",
    "type": "object",
    "properties": {
        "transaction": {
            "description": "updated INN-Reach transaction record",
            "$ref": "innReachTransactionDTO.json"
        },
        "folioCheckOut": {
            "description": "the FOLIO check-out response",
            "$ref": "circulation/loanDTO.json"
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
            "description": "Entity metadata",
            "type": "object",
            "$ref": "metadata.json"
        }
    },
    "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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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.
OkapiFatalError – 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": {
                "$ref": "innReachTransactionDTO.json"
            }
        }
    },
    "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

OkapiFatalError – 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": {
            "description": "D2IR Bib info",
            "type": "object",
            "$ref": "bibInfo.json"
        }
    },
    "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: OkapiFatalError – 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": {
                "$ref": "schemas/agenciesPerCentralServerDTO.json"
            }
        }
    },
    "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: OkapiFatalError – 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": {
                "type": "object",
                "$ref": "itemTypesPerCentralServerDTO.json"
            }
        },
        "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: OkapiFatalError – 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": {
                "type": "object",
                "$ref": "patronTypesPerCentralServerDTO.json"
            }
        },
        "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
OkapiFatalError – 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": {
            "description": "Transaction state",
            "type": "object",
            "$ref": "transactionStateEnum.json"
        },
        "type": {
            "description": "Transaction type",
            "type": "object",
            "$ref": "transactionTypeEnum.json"
        },
        "hold": {
            "description": "Transaction hold",
            "type": "object",
            "$ref": "transactionHoldDTO.json"
        },
        "metadata": {
            "description": "Entity metadata",
            "type": "object",
            "$ref": "metadata.json"
        }
    },
    "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
OkapiFatalError – 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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "additionalProperties": false,
    "required": [
        "status",
        "reason",
        "errors"
    ]
}

recallitemholdtransaction(id_)

Recall item hold transaction

POST /inn-reach/transactions/{id}/itemhold/recall

Raises

OkapiRequestNotFound – Item not found
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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
OkapiFatalError – 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": {
            "description": "Transaction state",
            "type": "object",
            "$ref": "transactionStateEnum.json"
        },
        "type": {
            "description": "Transaction type",
            "type": "object",
            "$ref": "transactionTypeEnum.json"
        },
        "hold": {
            "description": "Transaction hold",
            "type": "object",
            "$ref": "transactionHoldDTO.json"
        },
        "metadata": {
            "description": "Entity metadata",
            "type": "object",
            "$ref": "metadata.json"
        }
    },
    "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
OkapiFatalError – 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": {
                "$ref": "innReachError.json"
            }
        }
    },
    "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
OkapiFatalError – 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": {
            "description": "Transaction state",
            "type": "object",
            "$ref": "transactionStateEnum.json"
        },
        "type": {
            "description": "Transaction type",
            "type": "object",
            "$ref": "transactionTypeEnum.json"
        },
        "hold": {
            "description": "Transaction hold",
            "type": "object",
            "$ref": "transactionHoldDTO.json"
        },
        "metadata": {
            "description": "Entity metadata",
            "type": "object",
            "$ref": "metadata.json"
        }
    },
    "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: OkapiFatalError – 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": {
            "description": "D2IR Patron info",
            "type": "object",
            "$ref": "patronInfo.json"
        },
        "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"
    ]
}