Details:  Circulation Requests

URL:  https://yourlibrary.caiasoft.com/api/circrequests/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:
{"requests":[ { “name”:”value” (see table below) } ]}

Name	Value	Required	Notes
barcode	alphanumeric string	Yes	Item Barcode
request_type	Only values accepted: PYR ERT DEA SHP	Yes	Type of retrieval request which must match the job type requested PYR (Physical Retrieval) ERT (E-Retrieval) DEA (Deaccession) SHP (SH-I-P service)
stop	alphanumeric string	Yes	Must match a stop name or code or stop location name or code from your circulation stops list
request_id	alphanumeric string	No	Unique Request identifier from the sending system. Note that duplicate entries with the same request ID will be skipped in processing
requestor	alphanumeric string	No	Name of requesting party
patron_id	alphanumeric string	No	ID or email of requesting party
title	alphanumeric string	No	Title of requested item
author	alphanumeric string	No	Author of requested item
volume	alphanumeric string	No	Volume of requested item
call_number	alphanumeric string	No	Call number of requested item
article_title	alphanumeric string	No	Article title of requested item (for use in ERT scanning)
article_author	alphanumeric string	No	Article author of requested item (for use in ERT scanning)
article_pages	alphanumeric string	No	Article pages of requested item (for use in ERT scanning)
details	alphanumeric string	No	Additional request details

Return Response:  
{“success”:”true/false”, “error”:”string”, “request_count”:”int”, "results":[ { “name”:”value” (see results-> section of table below) } ]}

Name	Value	Notes
success	true/false
error	string	API format/key errors only. Will only be filled in when success = false
request_count	inte	Number of requests processed (regardless of denials, skipped requests)
results->barcode	string	Item Barcode Requested
results->deny	Y/N	Y if request denied N if request accepted See status for details
results->status	string	“Item Requested” OR Detail for request denial

Examples:  
API Call & JSON:

https://yourlibrary.caiasoft.com/api/circrequests/v1
{"requests":[ { "requestid":"123456", "request_type":"PYR", "barcode":"33433096043165", "stop":"LAW", "requestor":"Patron", "patron_id":"patron@abcdefg.com" }, { "requestid":"123457", "request_type":"PYR", "barcode":"31234000023075", "stop":"MAINLIB", "title":"Charlotte's Web", "author":"E.B. White", "call_number":"C121.4", "patron_id":"651393" } ]}

API Return:

{"success":true,"error":"", "request_count":"2", "results":[{"item":"33433096043165", "deny":"N", "istatus":"Item Requested"},{"item":"31234000023075", "deny":"Y", "istatus":"Item Cannot be Retrieved - Item is Currently Circulating"}]}