Available API Methods
The following methods are available:
.getCarDataByBusinessDate
The method, .getCarDataByBusinessDate, returns data in name/value pairs by business date.
Parameters
The .getCarDataByBusinessDate method requires one (1) of two (2) parameters:
Parameter | Required | Format | Description |
|---|---|---|---|
business_date | Yes | YYYY-MM-DD | The date of the query. |
secondary_date | No | YYYY-MM-DD | Optional. The secondary_date parameter represents the end of a date range. When used, the API returns timing data for the dates contained within the business_date and secondary_date parameters. The date assigned to secondary_date must occur after the date assigned to business_date. |
Request Example
{
"method": "Sicom.Dtd.OpenApi.getCarDataByBusinessDate",
"params": [ {
"business_date":"YYYY-MM-DD",
"secondary_date":"YYYY-MM-DD"
} ],
"id": 1,
"jsonrpc": "2.0"
}
.getCarDataByCalendarDate
The method, .getCarDataByCalendarDate, returns data in name/value pairs by calendar date.
Parameters
The .getCarDataByCalendarDate method requires one (1) of two (2) parameters:
Parameter | Required | Format | Description |
|---|---|---|---|
date | Yes | YYYY-MM-DD | The date of the query. |
secondary_date | No | YYYY-MM-DD | Optional. The secondary_date parameter represents the end of a date range. When used, the API returns timing data for the dates contained within the business_date and secondary_date parameters. The date assigned to secondary_date must occur after the date assigned to date. |
Request Example
{
"method": "Sicom.Dtd.OpenApi.getCarDataByCalendarDate",
"params": [ {
"date":"YYYY-MM-DD",
"secondary_date":"YYYY-MM-DD"
} ],
"id": 1,
"jsonrpc": "2.0"
}
.setApiUserAndPassword
The method, .setApiUserAndPassword changes the username and password used for API access to Drive Thru Director.
Parameters
The .setApiUserAndPassword method requires two (2) parameters:
Parameter | Required | Format | Description |
|---|---|---|---|
api_user | Yes | base64 encoded text | api user name |
api_password | Yes | base64 encoded text | api user password |
Request Example
{
"method": "Sicom.Dtd.OpenApi.setApiUserAndPassword",
"params": [{
"api_user": "base64_encoded_username",
"api_password": "base64_encoded_password"
}],
"id": 1,
"jsonrpc": "2.0"
}