REST APIs
GET
/accessioned_active
/accessionedlist
/accessioninfo
/accessioninfo_active
/bibmissing
/bibmissing_bydate
/circstoplist
/circstopout
/deaccessioninfo
/deaccessionedlist
/item
/itemloc
/itemstatus
/refiledlist
/retrievalinfo
/retrievedlist
/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
/circrequests
/incomingitems
/itemupdates
/itemsbybarcode
/itemloclist
/itemstatuslist
/union_author
/union_callnumber
/union_isbn
/union_issn
/union_lccn
/union_oclc
/union_title
/incomingitems
/itemupdates
/itemsbybarcode
/itemloclist
/itemstatuslist
/union_author
/union_callnumber
/union_isbn
/union_issn
/union_lccn
/union_oclc
/union_title
Additional Info
/accessioned_active
Details: Accessioned Items - Currently Active/ Have not been De-accessioned
API Return:
URL: https://yourlibrary.caiasoft.com/api/accessioned_active/v1/{accfrom}/{accto}/{collection}
HTTP Verb: GET
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters:
Name | Value | Required | Notes |
---|---|---|---|
accfrom | date in YYYYMMDD format | Yes | |
accto | date in YYYYMMDD format | Yes | Repeat accfrom 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. |
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 |
barcodes | array | List of barcodes accessioned in the date range queried *This will NOT INCLUDE any item that has since been de-accessioned. |
Examples:
API Call:
https://yourlibrary.caiasoft.com/api/accession_active/v1/20180227/20180228/ALL
API Return:
{"success":true,"error":"","count":20,"barcodes":["35405016075795", "35405016075739", "35405016075722", "35405016075713", "35405016075705", "35405016075694", "35405800037265", "35405016075631", "35405010818126", "35405010818117", "35405016075683", "35405016075672", "35405016075650", "35405016075645", "35405017171453", "35405017171272", "35405800216810", "3540580021691/","35405800216823", "35405800216883"]}