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
/itemloclist
URL: https://yourlibrary.caiasoft.com/api/itemloclist/v1/
HTTP Verb: POST
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters: JSON Formatted in the following format:
{“items":[
Comma separated barcode array
]}
Name | Value | Required | Notes |
---|---|---|---|
barcode | item barcode array | Yes | Comma separated if more than one barcode |
Return Response:
{“success”:”true/false”,
“error”:”string”,
"items":[
{
“name”:”value” (see items-> 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 |
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/itemloclist/v1/
{ "barcodes":
["31234000023075",
"31142000017943"]
}
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"},{"barcode":"31142000017943","status":"Item not Found","container":"","address":"","location":"","footprint":"","container_type":"","collection":"","material":"","accession date":"","last status update":""}]}
Full list of Statuses that can be returned