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
/retrievedlist
Details: Retrieved Item List
API Return:
URL: https://yourlibrary.caiasoft.com/api/retrievedlist/v1/{retfrom}/{retto}/{collection}
HTTP Verb: GET
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters:
Name | Value | Required | Notes |
---|---|---|---|
retfrom | date in YYYYMMDD format | Yes | |
retto | date in YYYYMMDD format | Yes | Repeat retfrom 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 Barcodes returned to location in list |
barcodes | array | List of barcodes retrieved in the date range queried |
Examples:
API Call:
https://yourlibrary.caiasoft.com/api/retrievedlist/v1/20180227/20180228/ALL
API Return:
{"success":true,"error":"", "count":6,"barcodes":["31742051589037", "31742030401619", "31742047810020", "31742103872648", "31742095278055", "31742811628693", "31742456844601"]}