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
/incomingitems
URL: https://yourlibrary.caiasoft.com/api/incomingitems/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:
{"incoming":[
{
“name”:”value” (see table below)
}
]}
Name | Value | Required | Notes |
---|---|---|---|
barcode | alphanumeric string | Yes | Item Barcode |
title | alphanumeric string | No | |
author | alphanumeric string | No | |
volume | alphanumeric string | No | |
call_number | alphanumeric string | No | |
collection | alphanumeric string | No | Must match collection code in system, or bibliographic location listed on collection code detail (for translation) |
material | alphanumeric string | No | Must match material type in system, or bibliographic material type listed on material type detail (for translation) |
oclc | alphanumeric string | No | |
issn | alphanumeric string | No | |
isbn | alphanumeric string | No | |
edition | alphanumeric string | No | |
copy_number | alphanumeric string | No | |
pages | alphanumeric string | No | |
publisher | alphanumeric string | No | |
pub_place | alphanumeric string | No | |
pub_year | alphanumeric string | No | |
physical_desc | alphanumeric string | No | |
format | alphanumeric string | No | |
packaging | alphanumeric string | No | |
condition | alphanumeric string | No | |
shared_contrib | alphanumeric string | No | Shared Print Contributor |
item_type | alphanumeric string | No | |
bib_location | alphanumeric string | No | |
bib_item_status | alphanumeric string | No | |
bib_item_code | alphanumeric string | No | |
bib_level | alphanumeric string | No | |
bib_item_id | alphanumeric string | No | |
bib_record_nbr | alphanumeric string | No |
Return Response:
{“success”:”true/false”,
“error”:”string”,
“incoming_count”:”int”,
“rejected_count”:”int”,
"rejects":[
{
“name”:”value” (see results-> section of table below)
},
"warnings":[
{
“name”:”value” (see results-> 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 |
incoming_count | inte | Number of incoming items processed (accepted and rejected) |
rejected_count | inte | Number of items rejected |
rejects->barcode | string | Item Barcode Rejected |
rejects->reason | string | Number of items Rejected |
warnings->barcode | string | Item Barcode with Warning |
warnings->warning | string | Warning Detail |
Examples:
API Call & JSON:
https://yourlibrary.caiasoft.com/api/incomingitems/v1
{"incoming":[
{
"barcode":"33433096993165",
"collection":"DEMO",
"title":"Jane Eyre"
},
{
"barcode":"31234000023075",
"call_number":"R34.5",
"physical_desc":"317 pages",
"title":"Wuthering Heights"
}
]}
API Return:
{"success":true,"error":"", "incoming_count":"2", "rejected_count":"1", "rejects":[{"item":"31234000023075", "reason":"Item already exists"}]}