Table of Contents | ||||
---|---|---|---|---|
|
...
Click the Headers link for more information on the API Header. Click the Making a Request link for the basics of initiating a request.
Using POST Calls
Excerpt | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Using POST Calls
|
SQL End Point
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/sql.OUTPUT |
...
Code Block | ||
---|---|---|
| ||
{ "status": "success", "page": "1", "count": 20, "total_count": "324500", "results": [ { "RECID": "1" }, { "RECID": "2" }, { "RECID": "3" }, { "RECID": "4" }, { "RECID": "5" }, { "RECID": "6" }, { "RECID": "7" }, { "RECID": "8" }, { "RECID": "9" }, { "RECID": "10" }, { "RECID": "11" }, { "RECID": "12" }, { "RECID": "13" }, { "RECID": "14" }, { "RECID": "15" }, { "RECID": "16" }, { "RECID": "17" }, { "RECID": "18" }, { "RECID": "19" }, { "RECID": "20" } ] } |
Classes of Service
Classes of Service values can be retrieved only through the SQL endpoint. Retrieving these values is needed for using the Authentication Token Mode of the API.
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/sql.json |
Body:
Key | Value |
---|---|
sql | SELECT RECID, CODE, DESCRIPTION FROM CLASSES_OF_SERVICE |
Return:
Code Block | ||
---|---|---|
| ||
{ "status": "success", "page": 1, "count": 3, "total_count": "3", "results": [ { "RECID": "1", "CODE": "0", "DESCRIPTION": "First Class" }, { "RECID": "2", "CODE": "9", "DESCRIPTION": "Second Class" }, { "RECID": "3", "CODE": "100", "DESCRIPTION": "Third Class" } ] } |
...