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
/deaccessioninfo
URL: https://yourlibrary.caiasoft.com/api/deacsessioninfo/v1/{deafrom}/{deato}/{collection}/{includereaccessed}
HTTP Verb: GET
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters:
Name | Value | Required | Notes |
---|---|---|---|
deafrom | date in YYYYMMDD format | Yes | Deaccessioned From |
accto | date in YYYYMMDD format | Yes | Deaccessioned ToRepeat deafrom date for one day. Field cannot be blank. |
collection | alphanumeric string | Yes | Single collection or Report Class (group of collections) accepted. Use “ALL” for all collections. |
includereaccession | Y/N | Yes | Y = Include items that have since been reaccessioned N = Only list items that are still status DEA |
Return Response:
Name | Value | Notes |
---|---|---|
success | true/false | |
error | string | API format/key errors only. Will only be filled in when success = false |
count | int | Count of accessed items into the date range |
items->barcode | string | Item Barcode |
items->collection | string | collection |
items->requestor | string | Requestor |
items->request id | string | Request Identifier (from API Initiating Request) |
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->deaccession job | int | Deaccession Job # |
items->deaccession date | string mm/dd/yyyy | Deaccession Date |
items->accession date | string mm/dd/yyyy | Original Accession Date of Item |
items->status update | string | If includereaccessed = "Y", then status will note when item has since been reaccessed/is now active |
Examples:
API Call:
https://yourlibrary.caiasoft.com/api/deaccessioninfo/v1/20180828/20180828/N
API Return:
{ "success": true, "error": "", "count": 1, "items": [ { "barcode": "34555800001352", "collection": "NN", "requestor": "John Jones", "request_id": "", "deaccession job": "10190", "deaccession date": "08-28-2018", "deaccession date": "02-28-2017", "status_update" : "" }]}