REST APIs
GET
/accessionedlist
/accessioninfo
/accessioned_active
/bibmissing
/bibmissing_bydate
/circstoplist
/circstopout
/item
/itemloc
/itemstatus
/refiledlist
/retrievedlist
/accessioninfo
/accessioned_active
/bibmissing
/bibmissing_bydate
/circstoplist
/circstopout
/item
/itemloc
/itemstatus
/refiledlist
/retrievedlist
POST w/file payloads
POST w/JSON payloads
Additional Info
/item
Details: Item Info
API Return:
Full list of Statuses that can be returned
URL: https://yourlibrary.caiasoft.com/api/item/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 |
items->barcode | string | Item Barcode |
items->status | string | Item Status (see Additional info for complete status list) |
items->collection | string | collection |
items->material | string | Material |
items->title | string | Title |
items->volume | string | Volume |
items->call number | string | Call Number |
items->item id | string | Item ID (from ILS) |
items->bib record nbr | string | Item Bib Record Number (from ILS) |
items->accession date | string mm/dd/yyyy | Accession Date |
items->last status date | string mm/dd/yyyy | Last Status Update Date |
Examples:
API Call:
https://yourlibrary.caiasoft.com/api/item/v1/31234000023075
API Return:
{"success":true,"error":"", "items":[ {"barcode":"31234000023075", "status":"Out on Physical Retrieval", "collection":"DEMO", "material":"BOOK", "title":"", "volume":"", "call number":"", "item id":"", "bib record nbr":"", "accession date":"06-26-2016", "last status update":"08-02-2016"} ]}
Full list of Statuses that can be returned