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
/requestfile
Details: Request Files (ERQ Job Load)
Sample CURL code in php:
API Return:
URL: https://yourlibrary.caiasoft.com/api/requestfile/v1
HTTP Verb: POST
Content-Type: multipart/form-data
Authorization Required:
Name | Value | Required | Notes |
---|---|---|---|
X-API-Key | string | Yes | send in header |
Parameters:
Name | Value | Required | Notes |
---|---|---|---|
requestfile | file | Yes | file prefix must match ‘begins’ value in file layout setup for correct layout match (multiple layouts accepted) |
Return Response:
Name | Value | Notes |
---|---|---|
success | true/false | |
error | string | Standard 404/403/File upload errors only. Any errors from the file contents will be displayed on the ERQ job in the Circulation Module. |
fileid | int | File Upload Identifier |
flayid | int | File Layout Utilized in Load |
Examples:
Sample CURL code at linux prompt/script:
curl -H "X-API-Key:
https://yourlibrary.caiasoft.com/api/requestfile/v1
Sample CURL code in php:
$postfields = [ 'requestfile' => '@' . realpath('') ]; $headerfields = [ 'Content-Type: multipart/form-data;', 'host: yourlibrary.caiasoft.com', 'X-API-Key: ' ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_HTTPHEADER, $headerfields); curl_setopt($ch, CURLOPT_HEADER, 0); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_URL, 'https://yourlibrary.caiasoft.com/api/requestfile/v1'); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, $postfields); $response = curl_exec($ch);
API Return:
{"success":true,"error":"","fileid":"395","flayid":"21"}