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
/circstopout
URL: https://yourlibrary.caiasoft.com/api/circstopout/v1/{circstop}
HTTP Verb: GET
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters:
Name | Value | Required | Notes |
---|---|---|---|
circstop | Existing Stop Code or ALL | Yes |
Return Response:
{“success”:”true/false”,
“error”:”string”,
“count”:”integer”,
"items_out":[
{
“name”:”value” (see items_out-> section of table below)
}
]}
Name | Value | Notes |
---|---|---|
success | true/false | |
error | string | API format/key errors only. Will only be filled in when success = false |
count | integer | Count of Items Outstanding to Stop |
items_out -> item | string | Item Barcode - NOTE: only items in collections that API Key has permissions to view will be included |
items_out -> circulation_stop | string | Full Stop and Location Name in String |
items_out -> days_outstanding | string | # 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" }]}