Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Click the Headers link for more information on the API Header. Click the Making a Request link for the basics of initiating a request.

SQL End Point

Code Block
languagesql
http://DOMAIN/api/API_KEY/sql.OUTPUT

...

Parameter

Required

Data Type

Options

Notes

sql

yes

string


SQL SELECT statement

Using the Data Dictionary

Please see the Data Dictionary for the structure of the database which will assist in creating queries.

The Data Dictionary can be used as an index to see what data might be related to other tables for ease in building up the SELECT and FROM portions of the statements you desire to build up. Specific data on identified fields can be further filtered in the WHERE portion of the statement.

Sample SQL Call

Call:

Code Block
languagesql
POST DOMAIN/KEY/sql.json

...

This call will be expected to RECIDs from the SERVICES Table in JSON format.

Sample Return

Code Block
languagesql
{
"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"
}
]
}