Vehicle - Drivers

The Admin interface handles web service calls from the Admin web gui. The base url for this is at:

/api/vehicle-admin

A JSON file with OpenAPI data about all vehicle-related admin APIs can be downloaded here.

Get Drivers

Gets the list of on-board device drivers available on the system:

GET /v1/drivers/list

Gets the list of on-board device drivers available on the system

Status Codes

200 OK – Success

Returns a Json positive response and the list of drivers:

[
  {
    ID: "9cfbca5c-3380-4b1f-b4e8-96606759659c",   // Guid
    DriverName: "Driver name"                     // String
  },
  ...
]

or a plain Json negative response if there was a problem retrieving the list.

Get Driver settings

Gets the list of settings for all device drivers:

GET /v1/drivers/settings/list

Gets the list of settings for all device drivers

Query Parameters

driverId (string) –

Status Codes

200 OK – Success

The API accepts the following filters in the query params: * driverId (Guid of the driver to be extracted)

Returns the list of the device drivers settings:

[
  {
    ID: 1,                                            // Int
    CreatedDate: "2001-01-01T01:01:01Z",              // DateTime
    LastUpdated: "2001-01-01T01:01:01Z",              // DateTime
    Driver: "53155c4a-b2a0-412f-ab41-552d9ccdf784",   // Guid
    Name: "...",                                      // String
    Value: "043402712643",                            // String
    DriverName: "Driver name"                         // String
  },
  ...
]

Edit driver setting

Persists a new value for a driver setting:

POST /v1/drivers/settings

Persists a new value for a driver setting

Status Codes

200 OK – Success

The body of the request is:

{
  ID: 123,                                            // Int
  Value: "New setting value"                          // String
}

where ID corresponds to an existing driver setting.

If the setting value was updated successfully, a plain Json positive response will be returned.

Possible error messages are:

err_InvalidElement: The ID provided does not correspond to an existing driver setting.

Get the list of accepted commands

Returns the list of the accepted commands for the specified driver:

GET /v1/drivers/{guid}/accepted-commands

Returns the list of accepted values for the provided driver <param name=”guid”>The guid of the driver</param>

Parameters

guid (string) –

Status Codes

200 OK – Success

The API will respond with the list of accepted commands:

{
  AcceptedCommands: [1, 2, ...],
  AcceptedResets: [1, 2, ...]
}

where AcceptedCommands values are among the TestType enumeration while AcceptedResets values are among the TestType enumeration, or with a plain error response.