/circstopout

Details:  Circulation Stop - Items Outstanding

URL:  https://yourlibrary.caiasoft.com/api/circstopout/v1/{circstop}

HTTP Verb:  GET

Authorization Required:  

NameValueRequiredNotes
X-API-KeystringYessend in header

Parameters:  

NameValueRequiredNotes
circstopExisting Stop Code or ALLYes

Return Response:  
{“success”:”true/false”, “error”:”string”, “count”:”integer”, "items_out":[ { “name”:”value” (see items_out-> section of table below) } ]}

NameValueNotes
successtrue/false
errorstringAPI format/key errors only. Will only be filled in when success = false
countintegerCount of Items Outstanding to Stop
items_out -> itemstringItem Barcode - NOTE: only items in collections that API Key has permissions to view will be included
items_out -> circulation_stopstringFull Stop and Location Name in String
items_out -> days_outstandingstring# of Days Item has been Circulating

Examples:  
API Call:

https://yourlibrary.caiasoft.com/api/circstopout/v1/AN



API Return:

{"success":true,"error":"","count":"3",""items_out": [{ "item": "110000002299", "circulation_stop": "AN - AN", "days_outstanding": "56" }, { "item": "110000003761", "circulation_stop": "AN - AN", "days_outstanding": "73" },{ "item": "110000004952", "circulation_stop": "AN - AN", "days_outstanding": "132" }]}