REST APIs
GET
/accessionedlist
/accessioninfo
/accessioninfo_active
/bibmissing
/bibmissing_bydate
/circstoplist
/circstopout
/deaccessioninfo
/deaccessionedlist
/item
/itemloc
/itemstatus
/refiledlist
/retrievalinfo
/retrievedlist
POST w/file payloads
POST w/JSON payloads
/incomingitems
/itemupdates
/itemsbybarcode
/itemloclist
/itemstatuslist
/union_author
/union_callnumber
/union_isbn
/union_issn
/union_lccn
/union_oclc
/union_title
Additional Info
/retrievalinfo
URL: https://yourlibrary.caiasoft.com/api/retrievalinfo/v1/{retfrom}/{retto}/{collection}
HTTP Verb: GET
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters:
Name | Value | Required | Notes |
---|---|---|---|
retfrom | date in YYYYMMDD format | Yes | |
retto | date in YYYYMMDD format | Yes | Repeat retfrom date for one day. Field cannot be blank. |
collection | alphanumeric string | Yes | Single collection or Report Class (group of collections) accepted. Use “ALL” for all collections. |
Return Response:
Name | Value | Notes |
---|---|---|
success | true/false | |
error | string | API format/key errors only. Will only be filled in when success = false |
count | int | Count of accessed items into the date range |
items->barcode | string | Item Barcode |
items->collection | string | collection |
items->requestor | string | Requestor |
items->request id | string | Request Identifier (from API Initiating Request) |
items->retrieval job | int | Retrieval Job |
items->retrieval date | string mm/dd/yyyy | Retrieval Date |
items->retrieval type | PYR (Physical)/ ERT (E-Retrieval) /SHP (SH-IP) /RRR (Reading Room Retrieval) | Retrieval Type |
Examples:
API Call:
https://yourlibrary.caiasoft.com/api/retrievalinfo/v1/20180828/20180828/ALL
API Return:
{ "success": true, "error": "", "count": 2, "items": [ { "barcode": "34555500001352", "collection": "NN", "requestor": "John Jones", "request_id": "", "retrieval_job": "8982", "retrieval date": "08-28-2018", "retrieval type": "ERT" }, { "barcode": "3455500561353", "collection": "PR", "requestor": "Bee Walters", "request_id": "TN4561", "retrieval_job": "8983", "retrieval date": "08-28-2018", "retrieval type": "PYR" }]}