/retrievalinfo

Details:  Retrieval Item info - Use this API to receive back full info on retrieved items, not just a barcode list

URL:  https://yourlibrary.caiasoft.com/api/retrievalinfo/v1/{retfrom}/{retto}/{collection}

HTTP Verb:  GET

Authorization Required:  

NameValueRequiredNotes
X-API-KeystringYessend in header

Parameters:  

NameValueRequiredNotes
retfromdate in YYYYMMDD formatYes
rettodate in YYYYMMDD formatYesRepeat retfrom date for one day. Field cannot be blank.
collectionalphanumeric stringYesSingle collection or Report Class (group of collections) accepted. Use “ALL” for all collections.

Return Response:  

NameValueNotes
successtrue/false
errorstringAPI format/key errors only. Will only be filled in when success = false
countintCount of accessed items into the date range
items->barcodestringItem Barcode
items->collectionstringcollection
items->requestorstringRequestor
items->request idstringRequest Identifier (from API Initiating Request)
items->retrieval jobintRetrieval Job
items->retrieval datestring mm/dd/yyyyRetrieval Date
items->retrieval typePYR (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" }]}