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
/itemsbybarcode
URL: https://yourlibrary.caiasoft.com/api/itemsbybarcode/v1
HTTP Verb: POST
Content-Type: application/json
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters: JSON Formatted in the following format:
{“barcodes":[
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”,
“item_count”:”int”,
"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 |
item_count | inte | Number of items received to update |
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->publisher | string | Publisher |
items->pub place | string | Pub Place |
items->pub year | string | Pub Year |
items->item id | string | Item ID (from ILS) ALMA MMS ID |
items->bib record nbr | string | Item Bib Record Number (from ILS) ALMA Holding ID |
items->pid | string | ALMA PID Note: will be blank for all other ILS connections |
items->accession date | string mm/dd/yyyy | Accession Date |
items->last status date | string mm/dd/yyyy | Last Status Update Date |
Examples:
API Call & JSON:
https://yourlibrary.caiasoft.com/api/itemsbybarcode/v1
{ "barcodes":
["33433096043124",
"308021014967264",
"33433096043280"]
}
API Return:
{"success":true,"error":"","item_count":"3",
"items":[ {"barcode":"33433096043124","status":"Pulled for E-Retrieval","collection":"DEMO","material":"BOOK","title":"","volume":null,"call number":"","item id":"","bib record nbr":"","accession date":"06-20-2016","last status update":"05-10-2019"}, {"barcode":"308021014967264","status":"Item Waiting on the External Retrieval Queue - Request ID 0","collection":"DEMO","material":"BOOK","title":"","volume":null,"call number":"","item id":"","bib record nbr":"","accession date":"06-20-2016","last status update":"06-20-2016"}, {"barcode":"33433096043280","status":"Item has been Deaccessioned","collection":"DEMO","material":"BOOK","title":"","volume":null,"call number":"","item id":"","bib record nbr":"","accession date":"06-20-2016","last status update":"10-19-2017"}
]}
Full list of Statuses that can be returned