Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 2021.3

Table of Contents
outlinetrue
stylenone

...

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

  • POST requests will ignore parameters supplied as a query string and need any additional parameters in the request Body.
  • To configure the number of Pages/Results returned by the API (this is most useful for the SQL Endpoint), you can send these as additional Parameter's in the Body.

    Parameter

    Data Type

    Default

    Description

    limit

    Interger

    20

    Number of listings to show.

    page

    Interger

    1

    Page number to show.


  • API fields are not case sensitive, and will always be returned in the lower case format.


SQL End Point

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

...

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"
		}
	]
}

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
languagesql
POST DOMAIN/KEY/sql.json

Body:

Key

Value

sql

SELECT RECID, CODE, DESCRIPTION FROM CLASSES_OF_SERVICE

Return:

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

...