/union_title

Details:  Union Holdings - Search by Title

URL:  https://yourlibrary.caiasoft.com/api/union_title/v1

HTTP Verb:  POST

Content-Type:  application/json

Authorization Required:  

NameValueRequiredNotes
X-API-KeystringYessend in header

Parameters:  JSON Formatted in the following format:
{ “name”:”value” (see table below) }

NameValueRequiredNotes
titlealphanumeric stringYes - minimum 5 charactersPortion of title - to be searched for as a contains - string appears somewhere in the title
volumealphanumeric stringNoPortion of volume - to be searched for as a contains - string appears somewhere in the volume
collectionalphanumeric stringNoMust 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) } ]}

NameValueNotes
successtrue/false
errorstringAPI format/key errors only. Can return even on success, as the json was accepted and possibly denied for formatting
item_countinteNumber of items returned in search
items->barcodestringItem Barcode
items->statusstringItem Status
See status list for possible responses
items->collectionstringItem Collection Code
items->titlestringTitle
items->volumestringVolume
items->authorstringAuthor
items->call numberstringCall Number
items->issnstringISSN
items->isbnstringISBN
items->oclcstringOCLC
items->lccnstringLCCN

Examples:  
API Call & JSON:

https://yourlibrary.caiasoft.com/api/union_title/v1
{ "title":"gift horse" }



API Return:

{"success":true,"error":"","item_count":"3","items":[{"barcode":"399910999","status":"Item In at Rest","collection":"DEMO","title":"Gift horse / ","volume":"","author":"Levin, Betty.","call number":"PZ7.L5759Gi 1996","issn":"","isbn":"9780688146986","oclc":"33206664","lccn":"95041840"},{"barcode":"390949999","status":"Item In at Rest","collection":"DEMO","title":"A gift horse, and other stories / ","volume":"","author":"O'Brien, Kathleen Cruise.","call number":"PR6065.B74Gi","issn":"","isbn":"0905169085:","oclc":"04808725","lccn":"78322687"},{"barcode":"399989281","status":"Item In at Rest","collection":"DEMO","title":"The gift horse; report on a life","volume":"","author":"Knef, Hildegard,","call number":"PN2658.N35A313","issn":"","isbn":"007035085X","oclc":"00148619","lccn":"74160709"}]}