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
/itemupdates
Note: items will only be updated if information sent does not match info on file. Blank values will not be updated (empty title value will not overwrite existing title on file).
URL: https://yourlibrary.caiasoft.com/api/itemupdates/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:
{"items":[
{
“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”,
“total_count”:”int”,
“updated_count”:”int”,
"errors":[
{
“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 |
total_count | inte | Number of items received to update |
updated_count | int | Number of items updated |
errors->barcode | string | Item Barcode w/Error |
errors->error_desc | string | Error Description – note this will not include items that had no info changes/no update needed |
warnings->barcode | string | Item Barcode with Warning |
warnings->warning | string | Warning Detail |
Note:
To update a field with a null value in order to clear the field, send the term "CLEARFIELD*" as the field value.
- "title" : "" or "title" : null -- will NOT prompt a change in the field.
- "title" : "CLEARFIELD*" -- will empty the field and record the change from previous value to empty
Examples:
API Call & JSON:
https://yourlibrary.caiasoft.com/api/itemupdates/v1
{
"barcode":"33433015998425",
"title":"Harry Potter and the Sorcerer’s Stone"
},
{
"barcode":"31234888023075",
"call_number":"R34.53",
}
]}
API Return:
{"success":true,"error":"","total_count":"2","updated_count":"1","errors":[{"item":"31234888023075","reason":"Item Not Found"}]}