REST APIs
GET
/accessioned_active
/accessionedlist
/accessioninfo
/accessioninfo_active
/bibmissing
/bibmissing_bydate
/circstoplist
/circstopout
/deaccessioninfo
/deaccessionedlist
/item
/itemloc
/itemstatus
/refiledlist
/retrievalinfo
/retrievedlist
/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
/circrequests
/incomingitems
/itemupdates
/itemsbybarcode
/itemloclist
/itemstatuslist
/union_author
/union_callnumber
/union_isbn
/union_issn
/union_lccn
/union_oclc
/union_title
/incomingitems
/itemupdates
/itemsbybarcode
/itemloclist
/itemstatuslist
/union_author
/union_callnumber
/union_isbn
/union_issn
/union_lccn
/union_oclc
/union_title
Additional Info
/itemloc
Details: Item Location
API Return:
Full list of Statuses that can be returned
URL: https://yourlibrary.caiasoft.com/api/itemloc/v1/{barcode}
HTTP Verb: GET
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters:
Name | Value | Required | Notes |
---|---|---|---|
barcode | alphanumeric string | Yes | Item Barcode |
Return Response:
Name | Value | Notes |
---|---|---|
success | true/false | |
error | string | API format/key errors only. Will only be filled in when success = false |
barcode | string | Item Barcode |
status | string | Item Status (see Additional info for complete status list) Note: if the API-Key provided does not have access to the collection to the item is in, an item restricted status will be returned in place of the actual item status. If you prefer the status to be "Item Not Found" (complete segregation of collections), please contact support. |
container | string | |
address | string | |
location | string | dash separated string of aisle, side, ladder, etc |
footprint | string | |
container type | string | |
collection | string | |
material | string | |
accession date | string | |
last status update | string |
Examples:
API Call:
https://yourlibrary.caiasoft.com/api/itemloc/v1/31234000023075
API Return:
{"success":true,"error":"","item":[{"barcode":"31234000023075","status":"Item In at Rest","container":"DH29996","address":"35555","location":"3-R-10-7","footprint":"2","container_type":"DH","collection":"DEMO","material":"BOOK","accession date":"11-16-2019","last status update":"11-16-2019"}]}
Full list of Statuses that can be returned