/incomingitems

Details:  Incoming Accession Items - JSON sent to URL to process one or more incoming accession items in a single post

URL:  https://yourlibrary.caiasoft.com/api/incomingitems/v1

HTTP Verb:  POST

Content-Type:  application/json

Authorization Required:  

NameValueRequiredNotes
X-API-KeystringYessend in header

Parameters:  JSON Formatted in the following format:
{"incoming":[
{
“name”:”value” (see table below)
}
]}

NameValueRequiredNotes
barcodealphanumeric stringYesItem Barcode
titlealphanumeric stringNo
authoralphanumeric stringNo
volumealphanumeric stringNo
call_numberalphanumeric stringNo
collectionalphanumeric stringNoMust match collection code in system, or bibliographic location listed on collection code detail (for translation)
materialalphanumeric stringNoMust match material type in system, or bibliographic material type listed on material type detail (for translation)
oclcalphanumeric stringNo
issnalphanumeric stringNo
isbnalphanumeric stringNo
editionalphanumeric stringNo
copy_numberalphanumeric stringNo
pagesalphanumeric stringNo
publisheralphanumeric stringNo
pub_placealphanumeric stringNo
pub_yearalphanumeric stringNo
physical_descalphanumeric stringNo
formatalphanumeric stringNo
packagingalphanumeric stringNo
conditionalphanumeric stringNo
shared_contribalphanumeric stringNoShared Print Contributor
item_typealphanumeric stringNo
bib_locationalphanumeric stringNo
bib_item_statusalphanumeric stringNo
bib_item_codealphanumeric stringNo
bib_levelalphanumeric stringNo
bib_item_idalphanumeric stringNo
bib_record_nbralphanumeric stringNo

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) } ]}

NameValueNotes
successtrue/false
errorstringAPI format/key errors only. Will only be filled in when success = false
incoming_countinteNumber of incoming items processed (accepted and rejected)
rejected_countinteNumber of items rejected
rejects->barcodestringItem Barcode Rejected
rejects->reasonstringNumber of items Rejected
warnings->barcodestringItem Barcode with Warning
warnings->warningstringWarning 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"}]}