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
/union_author
URL: https://yourlibrary.caiasoft.com/api/union_author/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:
{
“name”:”value” (see table below)
}
Name | Value | Required | Notes |
---|---|---|---|
author | alphanumeric string | Yes - minimum 5 characters | Portion of title - to be searched for as a contains - string appears somewhere in the title |
collection | alphanumeric string | No | Must match a collection code assigned to at least one active item |
Return Response: NOTE: Active Items Only (No De-accessions Returned)
{“success”:”true/false”,
“error”:”string”,
“item_count”:”int”,
"items":[
{
“name”:”value” (see results-> section of table below)
}
]}
Name | Value | Notes |
---|---|---|
success | true/false | |
error | string | API format/key errors only. Can return even on success, as the json was accepted and possibly denied for formatting |
item_count | inte | Number of items returned in search |
items->barcode | string | Item Barcode |
items->status | string | Item Status See status list for possible responses |
items->collection | string | Item Collection Code |
items->title | string | Title |
items->volume | string | Volume |
items->author | string | Author |
items->call number | string | Call Number |
items->issn | string | ISSN |
items->isbn | string | ISBN |
items->oclc | string | OCLC |
items->lccn | string | LCCN |
Examples:
API Call & JSON:
https://yourlibrary.caiasoft.com/api/union_author/v1
{
"author":"Levinson, Paul"
}
API Return:
{"success":true,"error":"","item_count":"3","items":[{"barcode":"30513093","status":"Item In at Rest","collection":"DEMO","title":"The pixel eye / ","volume":"","author":"Levinson, Paul.","call number":"PS3562.E92165P595 2003","issn":"","isbn":"0765305569 (acid-free paper)","oclc":"51755816","lccn":"2003042647"},{"barcode":"27631701","status":"Item In at Rest","collection":"DEMO","title":"Borrowed tides / ","volume":"","author":"Levinson, Paul.","call number":"PS3562.E92165B67 2001","issn":"","isbn":"0312848692","oclc":"45086989","lccn":"00048809"},{"barcode": "28714109","status":"Item In at Rest","collection":"DEMO","title":"The consciousness plague / ","volume":"","author":"Levinson, Paul","call number":"PS3562.E92165C66 2002","issn":"","isbn":"0765300982|(acid-free|paper)|:","oclc":"48451043","lccn":"2001054059"}]}