Details:  Circulation Stop List

URL:  https://yourlibrary.caiasoft.com/api/circstoplist/v1/{status}

HTTP Verb:  GET

Authorization Required:  

Name	Value	Required	Notes
X-API-Key	string	Yes	send in header

Parameters:  

Name	Value	Required	Notes
status	ACTIVE or ALL	Yes

Return Response:  
{“success”:”true/false”, “error”:”string”, “count”:”integer”, "stoplist":[ { “name”:”value” (see items-> 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
count	integer	Count of Stops Returned
stoplist -> stop_code	string
stoplist -> stop_name	string
stoplist -> location_name	string	Note - One stop code can have multiple locations, which are listed separately
stoplist -> status	string
stoplist -> delivery_pyr	string	Yes if location is accepting Physical Retrieval (PYR) Requests
stoplist -> delivery_ert	string	Yes if location is accepting E-Retrieval (ERT) Requests
stoplist -> delivery_rrr	string	Yes if location is accepting Reading Room Retrieval (RRR) Requests
stoplist -> delivery_shp	string	Yes if location is accepting Special Handling, Internal & Preservation (SHP) Requests

Examples:  
API Call:

https://yourlibrary.caiasoft.com/api/circstoplist/v1/ACTIVE

API Return:

{"success":true,"error":"","count":"3","stoplist":[{"stop_code":"ERT","stop_name":"E-Retrieval","stop_location":"E-Retrieval Default","stop_status":"Active","delivery_pyr":"No","delivery_ert":"Yes","delivery_rrr":"No","delivery_shp":"No"},{"stop_code":"MAIN","stop_name":"Main Library","stop_location":"Default","stop_status":"","delivery_pyr":"Yes","delivery_ert":"No","delivery_rrr":"No","delivery_shp":"Yes"},{"stop_code":"MAIN","stop_name":"Main Library ","stop_location":"Student Union","stop_status":"","delivery_pyr":"Yes","delivery_ert":"No","delivery_rrr":"No","delivery_shp":"Yes"}]}