Edge RTAC API to interface with FOLIO for 3rd party discovery services to determine holdings availability
| instanceId required | string Course Instance's UUID |
| fullPeriodicals | boolean Flag for including items data |
| lang | string[a-zA-Z]{2} Default: "en" Example: lang=en Requested language |
| apiKey | string apikey for authorization |
| authorization | string apikey for authorization |
| x-okapi-tenant | string x-okapi-tenant header value |
| x-okapi-url | string x-okapi-url header value |
| x-okapi-token | string x-okapi-token header value |
{- "instanceId": "string",
- "holdings": [
- {
- "id": "string",
- "callNumber": "string",
- "location": "string",
- "locationCode": "string",
- "locationId": "string",
- "status": "string",
- "dueDate": "string",
- "tempLocation": "string",
- "volume": "string",
- "temporaryLoanType": "string",
- "permanentLoanType": "string",
- "holdingsCopyNumber": "string",
- "itemCopyNumber": "string",
- "itemDisplayOrder": 0,
- "barcode": "string",
- "suppressFromDiscovery": true,
- "totalHoldRequests": 0,
- "materialType": {
- "id": "string",
- "name": "string"
}, - "library": {
- "name": "string",
- "code": "string"
}, - "notes": [
- {
- "note": "string",
- "noteType": "string",
- "staffOnly": true
}
], - "holdingsStatements": [ ],
- "holdingsStatementsForIndexes": [
- {
- "statement": "string",
- "note": "string"
}
], - "holdingsStatementsForSupplements": [
- {
- "statement": "string",
- "note": "string"
}
]
}
]
}| instanceIds | string^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA... List of Folio instance identifiers |
| fullPeriodicals | boolean Flag for including items data |
| lang | string[a-zA-Z]{2} Default: "en" Example: lang=en Requested language |
| apiKey | string apikey for authorization |
| authorization | string apikey for authorization |
| x-okapi-tenant | string x-okapi-tenant header value |
| x-okapi-url | string x-okapi-url header value |
| x-okapi-token | string x-okapi-token header value |
{- "holdings": [
- {
- "instanceId": "string",
- "holdings": [
- {
- "id": "string",
- "callNumber": "string",
- "location": "string",
- "locationCode": "string",
- "locationId": "string",
- "status": "string",
- "dueDate": "string",
- "tempLocation": "string",
- "volume": "string",
- "temporaryLoanType": "string",
- "permanentLoanType": "string",
- "holdingsCopyNumber": "string",
- "itemCopyNumber": "string",
- "itemDisplayOrder": 0,
- "barcode": "string",
- "suppressFromDiscovery": true,
- "totalHoldRequests": 0,
- "materialType": {
- "id": "string",
- "name": "string"
}, - "library": {
- "name": "string",
- "code": "string"
}, - "notes": [
- {
- "note": "string",
- "noteType": "string",
- "staffOnly": true
}
], - "holdingsStatements": [ ],
- "holdingsStatementsForIndexes": [
- {
- "statement": "string",
- "note": "string"
}
], - "holdingsStatementsForSupplements": [
- {
- "statement": "string",
- "note": "string"
}
]
}
]
}
], - "errors": [
- {
- "message": "string",
- "code": "string"
}
]
}| instanceId required | string Course Instance's UUID |
| query required | string The keyword query in CQL format |
| available | boolean Filter by holdings that are available |
| limit | integer [ 0 .. 500 ] Default: 100 Limit the number of elements returned in the response. |
| offset | integer [ 0 .. 100000 ] Default: 0 Skip over a number of elements by specifying an offset value for the query. |
| apiKey | string apikey for authorization |
| authorization | string apikey for authorization |
"string"| instanceId required | string Course Instance's UUID |
| limit | integer [ 0 .. 500 ] Default: 100 Limit the number of elements returned in the response. |
| offset | integer [ 0 .. 100000 ] Default: 0 Skip over a number of elements by specifying an offset value for the query. |
| apiKey | string apikey for authorization |
| authorization | string apikey for authorization |
"string"| instanceIds required | Array of strings (uuid) [ items^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-... ] Inventory instances identifiers |
{- "instanceIds": [
- "string"
]
}"string"