Introduction

This document describes the **autoaid Connected Car REST API** where you can get information about the status of your fleet.

Basic Concepts

These are the basic objects that we use to structure the data:

  • Device: The OBD dongle hardware which is used to interface with the vehicle

  • Vehicle: The car in which the OBD dongle is installed

  • Trip: A defined time interval where the car was driving

  • Event: A measurement or status update generated by the dongle

Security

You must use **Bearer Authentication** with an API key to use the service. Please contact info@autoaid.de if you haven't received an API key.

Endpoint

The endpoint to access data from version v2 is:

  • https://api-production.autoaid.de/cc/v2.0

List Devices

This method returns a list of all devices that are visible to the API key user. The user should provide a timestamp that is used for filtering, so that only devices are returned which have sent new data after the specified time.


Request

GET
/devices
Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US) Available values : *, en, de, en-US, de-DE'

deviceIds
(query)
string
Return devices witch are in a defined list, e.g. 861359033310655, 861359033310600, 861359033310622

isOnline
(query)
boolean
Return devices witch are currently online or offline.

isPluggedIn
(query)
boolean
Return devices witch are currently plugged into a vehicle or not.

fromTimestamp
(query)
string($date-time)
Return devices within time range.

toTimestamp
(query)
string($date-time)
Return devices within time range.

filterTimestamp
(query)
string($date-time)
Return results which are newer than this timestamp (with respect to modifyTimestamp).

maxResults
(query)
integer
How many results to return, default value: 500 (maximum 10,000).
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/devices' \
-d isOnline=true \
-d isPluggedIn=true \
-d deviceIds=861359033310655,861359033310600,861359033310622
-d fromTimestamp=2020-02-22T14:37:07.797Z \
-d toTimestamp=2020-02-22T14:37:07.797Z \
-d filterTimestamp=2020-02-22T14:37:07.797Z \
-d maxResults=100 \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the list of my devices.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.

{
    "devices": [
        {
            "id": 861359038274344,
            "manufacturer": "autoaid",
            "hardwareType": "dongle",
            "hardwareVersion": "C5",
            "firmwareVersion": "1 Aug 16 2019",
            "isOnline": true,
            "isPluggedIn": true,
            "vehicleId": "VINYV1ZW25UDK1332944",
            "tripId": "90f228de5c611c7148d5",
            "modifyTimestamp": "2020-02-03T13:58:46.775Z"
        }
    ],
    "modifyTimestamp": "2020-02-03T13:58:46.775Z"
}

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

Get Device

This method returns information about a single device identified by its IMEI.


Request

GET
/devices/{deviceId}
deviceId
(path)
integer($int64)
Required, IMEI of device.

Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US). Available values : *, en, de, en-US, de-DE

filterTimestamp
(query)
string($date-time)
Return results which are newer than this timestamp (with respect to modifyTimestamp).
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/devices/861359038274344' \
-d filterTimestamp=2020-02-22T14:37:07.797 \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the data for the device.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.

{
    "id": 861359038274344,
    "manufacturer": "autoaid",
    "hardwareType": "dongle",
    "hardwareVersion": "C5",
    "firmwareVersion": "1 Aug 16 2019",
    "isOnline": true,
    "isPluggedIn": true,
    "vehicleId": "VINYV1ZW25UDK1332944",
    "tripId": "90f228de5c611c7148d5",
    "modifyTimestamp": "2020-02-03T13:58:46.775Z"
}

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

List Vehicles

This method returns a list of all vehicles that are visible to the API key user. The user should provide a timestamp that is used for filtering, so that only vehicles are returned which have new data after the specified time. Each vehicle object contains also a list of the last events for each event type which have been collected for the vehicle. This way you can easily access the last position or mileage without making a separate request to /events.


Request

GET
/vehicles
Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE

deviceId
(query)
integer($int64)
The identifier for the device, i.e. the IMEI.

maxResults
(query)
integer
How many results to return, default value: 500 (maximum 10,000).

fromTimestamp
(query)
string($date-time)
Return vehicles within time range.

toTimestamp
(query)
string($date-time)
Return vehicles within time range.

filterTimestamp
(query)
string($date-time)
Return results which are newer than this timestamp (with respect to modifyTimestamp).
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/vehicles' \
-d deviceId=861359033310655 \
-d maxResults=100 \
-d filterTimestamp=2020-02-22T14:37:07.797 \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the list of my vehicles.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.

{
    "vehicles": [
        {
            "id": "VINYV1ZW25UDK1332944",
            "vin": "YV1ZW25UDK1332944",
            "tecDocMakeId": 120,
            "tecDocModelId": 38603,
            "tecDocVehicleId": 0,
            "make": "VOLVO",
            "model": "V60 II (225)",
            "vehicle": "T5",
            "fuelType": "Petrol",
            "kba": "0588AHA",
            "licensePlate": "B-AA 896",
            "deviceId": 861359033310655,
            "tripId": "90f228de5c611c7148d5",
            "lastEvents": [
                {
                    "deviceId": 861359038274344,
                    "recordedTimestamp": "2019-11-28T18:51:20.815Z",
                    "eventType": "MILEAGE",
                    "dataType": "NUMBER",
                    "value": 35538,
                    "unit": "km",
                    "unitId": 111
                }
            ],
            "modifyTimestamp": "2019-11-28T18:51:20.815Z"
        }
    ],
    "modifyTimestamp": "2019-11-28T18:51:20.815Z"
}

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

Get Vehicle

This method returns information about a single vehicle. It is identified by its VIN together with the prefix 'VIN' (e.g. VINWAUZZZ123456789) so that the id is 20 characters long. If the VIN is unknown, you can use the device's IMEI to reference the vehicle like this: IMEI_861359033499999.

The vehicle object contains also a list of the last events for each event type which have been collected for the vehicle. This way you can easily access the last position or mileage without making a separate request to /events.


Request

GET
/vehicles/{vehicleId}
vehicleId
(path)
string
Required - The identifier of the vehicle

Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE

deviceId
(query)
integer($int64)
The identifier for the device, i.e. the IMEI.

filterTimestamp
(query)
string($date-time)
Return results which are newer than this timestamp (with respect to modifyTimestamp).
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/vehicles/VINYV1ZW25UDK1332944' \
-d filterTimestamp=2020-02-22T14:37:07.797 \
-d deviceId=861359033310655 -H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the data for the vehicle.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response

{
    "id": "VINYV1ZW25UDK1332944",
    "vin": "YV1ZW25UDK1332944",
    "tecDocMakeId": 120,
    "tecDocModelId": 38603,
    "tecDocVehicleId": 0,
    "make": "VOLVO",
    "model": "V60 II (225)",
    "vehicle": "T5",
    "fuelType": "Petrol",
    "kba": "0588AHA",
    "licensePlate": "B-AA 896",
    "deviceId": 861359033310655,
    "tripId": "90f228de5c611c7148d5",
    "lastEvents": [
        {
            "deviceId": 861359038274344,
            "recordedTimestamp": "2019-11-28T18:51:20.815Z",
            "eventType": "MILEAGE",
            "dataType": "NUMBER",
            "value": 35538,
            "unit": "km",
            "unitId": 111
        }
    ],
    "modifyTimestamp": "2019-11-28T18:51:20.815Z"
}

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

Update Vehicle

Use this method to add settings like number plate to a vehicle.


Request

PUT
/vehicles/{vehicleId}/settings
vehicleId
(path)
string
Required - The identifier of the vehicle

Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE

settings
(body)
object
{
    "settings": {
        "numberPlate": "B-AA 201",
        "vin": "YV1ZW25UDK1332944"
    }
}
curl -X POST -G \
'https://api-production.autoaid.de/cc/v2.0/vehicles/VINYV1ZW25UDK1332944/settings' \
--data-raw '{ "numberPlate" : "B-AA 201" }' \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en' \
-H 'Content-Type: application/json'

Response 200: Request Successful


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

List Trips

Get a list of the trips for my account or for a specified vehicle or device.


Request

GET
/trips
Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE

deviceId
(query)
integer($int64)
The identifier for the device, i.e. the IMEI.

vehicleId
(query)
string
The identifier of the vehicle.

fromTimestamp
(query)
string($date-time)
Return trips within time range.

toTimestamp
(query)
string($date-time)
Return trips within time range.

maxResults
(query)
integer
How many results to return, default value: 500 (maximum 10,000).

filterTimestamp
(query)
string($date-time)
Return results which are newer than this timestamp (with respect to modifyTimestamp).
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/trips' \
-d deviceId=861359038274344 \
-d vehicleId=VINYV1ZW25UDK1332944 \
-d fromTimestamp=2020-02-22T00:00:00 \
-d toTimestamp=2020-02-23T00:00:00 \
-d maxResults=100 \
-d filterTimestamp=2020-02-22T14:37:07.797 \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns a list with trips and basic data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.

{
    "trips": [
        {
            "id": "30b80666a025b5eb41bx",
            "deviceId": 861359038274344,
            "vehicleId": "VINYV1ZW25UDK1332944",
            "tripStartAddress": {
                "id": "20e116de5c633c8148ff",
                "road": "Helmholtzstra\u00dfe",
                "houseNumber": "2-9",
                "suburb": "Charlottenburg",
                "locality": "Berlin",
                "state": "Berlin",
                "country": "Germany",
                "postcode": "10587",
                "lat": 52.520374,
                "lon": 13.32426
            },
            "tripEndAddress": {
                "id": "20e116de5c633c8148ff",
                "road": "Helmholtzstra\u00dfe",
                "houseNumber": "2-9",
                "suburb": "Charlottenburg",
                "locality": "Berlin",
                "state": "Berlin",
                "country": "Germany",
                "postcode": "10587",
                "lat": 52.520374,
                "lon": 13.32426
            },
            "distance": 60,
            "duration": 3600,
            "tripStartTimestamp": "2020-02-03T13:00:00.775Z",
            "tripEndTimestamp": "2020-02-03T14:00:00.775Z",
            "aggregations": [
                {
                    "eventType": "MILEAGE",
                    "dataType": "NUMBER",
                    "aggregationType": "START",
                    "value": 32100,
                    "unit_id": 111,
                    "unit": "km"
                },
                {
                    "eventType": "MILEAGE",
                    "dataType": "NUMBER",
                    "aggregationType": "END",
                    "value": 32160,
                    "unit_id": 111,
                    "unit": "km"
                },
                {
                    "eventType": "POSITION",
                    "dataType": "STRING",
                    "aggregationType": "POLYLINE",
                    "value": "oufn_BwdqnO_AaG`Ij@b]k@jFyY_AykCkL}m@e]gk@gc@q`@c[mPqf@aO}m@kHq{"
                }
            ],
            "deleteTimestamp": null,
            "modifyTimestamp": "2020-02-03T14:00:00.775Z"
        }
    ],
    "modifyTimestamp": "2020-02-03T14:00:00.775Z"
}

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

Get Trip

Get the data for a single trip.


Request

GET
/trip/{tripId}
tripId
(path)
string
Required, the identifier of the trip.

Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE

filterTimestamp
(query)
string($date-time)
Return results which are newer than this timestamp (with respect to modifyTimestamp).
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/trips/30b80666a025b5eb41bx' \
-d filterTimestamp=2020-02-22T14:37:07.797 \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the data for the trip.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.

{
    "id": "30b80666a025b5eb41bx",
    "deviceId": 861359038274344,
    "vehicleId": "VINYV1ZW25UDK1332944",
    "tripStartAddress": {
        "id": "20e116de5c633c8148ff",
        "road": "Helmholtzstra\u00dfe",
        "houseNumber": "2-9",
        "suburb": "Charlottenburg",
        "locality": "Berlin",
        "state": "Berlin",
        "country": "Germany",
        "postcode": "10587",
        "lat": 52.520374,
        "lon": 13.32426
    },
    "tripEndAddress": {
        "id": "20e116de5c633c8148ff",
        "road": "Helmholtzstra\u00dfe",
        "houseNumber": "2-9",
        "suburb": "Charlottenburg",
        "locality": "Berlin",
        "state": "Berlin",
        "country": "Germany",
        "postcode": "10587",
        "lat": 52.520374,
        "lon": 13.32426
    },
    "distance": 60,
    "duration": 3600,
    "tripStartTimestamp": "2020-02-03T13:00:00.775Z",
    "tripEndTimestamp": "2020-02-03T14:00:00.775Z",
    "aggregations": [
        {
            "eventType": "MILEAGE",
            "dataType": "NUMBER",
            "aggregationType": "START",
            "value": 32100,
            "unit_id": 111,
            "unit": "km"
        },
        {
            "eventType": "MILEAGE",
            "dataType": "NUMBER",
            "aggregationType": "END",
            "value": 32160,
            "unit_id": 111,
            "unit": "km"
        },
        {
            "eventType": "POSITION",
            "dataType": "STRING",
            "aggregationType": "POLYLINE",
            "value": "oufn_BwdqnO_AaG`Ij@b]k@jFyY_AykCkL}m@e]gk@gc@q`@c[mPqf@aO}m@kHq{"
        }
    ],
    "deleteTimestamp": null,
    "modifyTimestamp": "2020-02-03T14:00:00.775Z"
}

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

List Events

Get the list of events for a device, a vehicle or a trip. You should provide one of these ids together with fromTimestamp and toTimestamp, so that the number of events remains smaller than maxResults. You can also specify a list of eventTypes to filter, e.g. eventType=POSITION,MILEAGE.


Request

GET
/events
Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE

deviceId
(query)
integer($int64)
The identifier for the device, i.e. the IMEI.

vehicleId
(query)
string
The identifier of the vehicle.

tripId
(query)
string
The identifier of the trip.

eventType
(query)
string
Defines the type of events which should be returned. Available values: MILEAGE, POSITION, FUEL_LEVEL_PERCENT, FUEL_LEVEL

maxResults
(query)
integer
How many results to return, default value: 500 (maximum 10,000).
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/events' \
-d deviceId=861359033310655 \
-d vehicleId=VINYV1ZW25UDK1332944 \
-d eventType=MILEAGE,POSITION,IS_IGNITION_ON \
-d maxResults=100 \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the list of matching events.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
[
    {
        "event_type": "POSITION",
        "data_type": "GEO",
        "value": "POINT(13.428973 52.515955)",
        "device_id": 861359033310655,
        "recorded_timestamp": "2019-07-10T09:20:01.999Z"
    },
    {
        "event_type": "MILEAGE",
        "data_type": "NUMBER",
        "unit": "km",
        "unit_id": 111,
        "value": 22141,
        "device_id": 861359033310655,
        "recorded_timestamp": "2019-07-10T09:20:01.999Z"
    },
    {
        "event_type": "IS_IGNITION_ON",
        "data_type": "BOOLEAN",
        "value": true,
        "device_id": 861359033310655,
        "recorded_timestamp": "2019-07-10T09:20:01.999Z"
    }
]

List Dtcs

Get a list of the current Diagnostic Trouble Codes (DTC).


Request

GET
/dtcs
Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE

deviceId
(query)
integer($int64)
The identifier for the device, i.e. the IMEI.

vehicleId
(query)
string
The identifier of the vehicle.

fromTimestamp
(query)
string($date-time)
Return dtc list within time range.

toTimestamp
(query)
string($date-time)
Return dtc list within time range.

maxResults
(query)
integer
How many results to return, default value: 500 (maximum 10,000).

filterTimestamp
(query)
string($date-time)
Return results which are newer than this timestamp (with respect to modifyTimestamp).
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/dtcs' \
-d deviceId=861359038274344 \
-d vehicleId=VINYV1ZW25UDK1332944 \
-d fromTimestamp=2020-02-22T00:00:00Z \
-d toTimestamp=2020-02-23T00:00:00Z \
-d filterTimestamp=2020-02-22T14:37:07.797Z \
-d maxResults=100 \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the list of current fault codes.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.

{
    "dtcs": [
        {
            "id": "ee7184fd3a71548cf773",
            "vehicleId": "VINYV1ZW25UDK1332944",
            "deviceId": 861359033310655,
            "ecuTypeId": 91,
            "ecuType": "Engine Control Module (ECM)",
            "code": "3DE3",
            "encoded": "3DE3",
            "encoding": "HEX",
            "label": "DC/DC BOOST MODE LOW VOLTAGE SIDE",
            "dtcType": "Permanent",
            "recordedTimestamp": "2020-09-02T16:49:18.805Z",
            "deleteTimestamp": null,
            "modifyTimestamp": "2020-09-02T16:49:18.864196Z"
        }
    ],
    "modifyTimestamp": "2020-09-02T16:49:18.864196Z"
}

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

List Aggregations

Aggregations contain the statistics of events such as min, max, average etc. The values are grouped and aggregated into "bins" of equal size depending on the selected time interval (DAY, MONTH, YEAR).
Use this method if you need to get monthly mileage reports for a vehicle or the total fuel consumption of your entire fleet.


Request

GET
/aggregations
Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE

vehicleId
(query)
string
The identifier of the vehicle or "ALL" to aggregate data for the entire fleet.

aggregation
(query)
string
Defines the type of the collected data which should be returned. Available values: DRIVEN_DISTANCE, TRIP_DURATION

aggregationType
(query)
string
Defines the type of the aggregation. Available values: MIN, MAX, AVG, SUM. Default: Return all aggregations.

bin
(query)
string
Defines how aggregations are grouped. Available values: VEHICLE, FLEET

binSize
(query)
string
Defines the time over which aggregation is performed. Available values: DAY, WEEK, MONTH, YEAR. Default: DAY

fromTimestamp
(query)
string($date-time)
Return values within time range.

toTimestamp
(query)
string($date-time)
Return values within time range.
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/aggregations' \
-d vehicleId=VINYV1ZW25UDK1332944 \
-d aggregation=DRIVEN_DISTANCE,TRIP_DURATION \
-d aggregationType=SUM,AGV,MIN,MAX \
-d binSize=DAY \
-d bin=VEHICLE \
-d fromTimestamp=2019-07-01T00:00:00 \
-d toTimestamp=2019-07-03T00:00:00 \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the list of matching aggregations.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
[
    {
        "vehicleId": "VINYV1ZW25UDK1332944",
        "eventType": "MILEAGE",
        "dataType": "NUMBER",
        "aggregationType": "DIFFERENCE",
        "value": 200.5,
        "unit": "km",
        "unitId": 111,
        "bin": "2019-07-01T00:00:00"
    },
    {
        "vehicleId": "VINYV1ZW25UDK1332944",
        "eventType": "MILEAGE",
        "dataType": "NUMBER",
        "aggregationType": "DIFFERENCE",
        "value": 70.3,
        "unit": "km",
        "unitId": 111,
        "bin": "2019-07-02T00:00:00"
    }
]

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

List Event Types

Get list of all supported event types and their names, e.g. FUEL_LEVEL, BATTERY_VOLTAGE


Request

GET
/eventTypes
Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE
curl -X GET -G \
'https://api-production.autoaid.de/cc/v2.0/eventTypes' \
-H 'Authorization: Bearer apiKey' \
-H 'Accept-Language: en'

Response 200: Request Successful

Returns the list of event types.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.

[
    {
        "eventType": "BATTERY_VOLTAGE",
        "dataType": "NUMBER",
        "unit": "V",
        "unitId": 40
    }
]

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

List Unit Types

Get List of all available unit types for parameter measurements, e.g. °C, V or km/h


Request

GET
/units
Accept-Language
(header)
string
Select the preferred language in which the server should return the results (defaults to en-US)'. Available values : *, en, de, en-US, de-DE
                        
curl -X GET \
  'https://api-cc/v2/units' \
  -H 'Authorization: Bearer  apiKey' \
  -H 'Accept-Language: en_US' \
                        
                    

Response 200: Request Successful

Returns the list of units.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.

[
  {
    "id": 112,
    "unitType": "km/h"
  }
]

Response 400: Bad Request

The server cannot or will not process the request due to an apparent client error (e.g., malformed request syntax).


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 429: Too Many Requests

The user has sent too many requests in a given amount of time.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 403: Forbidden

The user does not have the permission to receive this type of data.


X-Rate-Limit
(header)
integer
The total number of allowed requests in the current period.
X-Rate-Limit-Remaining
(header)
integer
The number of remaining requests in the current period.
X-Response-Time
(header)
integer
The number of milliseconds that the server needed to generate the response.
{
    "errorMessage": "An error has occurred while processing the request."
}

Response 401: Unauthorized

The user did not provide a valid API key.


{
    "errorMessage": "Unauthorized."
}

Events

Events can be distinguished by their type. Each eventType is unique but differs in the dataType to support string, float, boolean values and object values for position events. Events with dataType NUMBER include the additional fields unit and unitId. The values for eventType,dataType,unitId and unit are defined for each event.

Dongle Specific Events

Event Type
Data Type
Unit
Unit ID
Interval
Trigger
Description
BATTERY_VOLTAGE
NUMBER
V
40
60
interval, later when changed
Battery voltage value.
DRIVEN_DISTANCE
NUMBER
km
111
60
interval
Driven distance since last report.
FIRMWARE_VERSION
STRING
-
-
-
trip start
Current firmware of the dongle.
GPS_ALTITUDE
NUMBER
m
110
60
interval or direction change
Current height in meters.
GPS_COURSE
NUMBER
°
60
60
interval or direction change
Current course in degree.
GPS_HDOP
NUMBER
10
60
interval or direction change
Accuracy of the gps positions.
GPS_SATELLITES_IN_USE
NUMBER
10
60
interval
Current gnss satellites in view.
GPS_SATELLITES_IN_VIEW
NUMBER
10
60
interval
Current gnss satellites in use.
GPS_SPEED
NUMBER
km/h
121
60
interval or direction change
Current speed in kmh.
IMSI
STRING
-
-
-
trip start
Sim card imsi id.
IS_DONGLE_IN_STANDBY
BOOLEAN
-
-
-
when changed
Signal if dongle is in standby mode or leaving standby mode.
IS_DONGLE_PLUGGED_IN
BOOLEAN
-
-
-
when changed
Signal if the dongle is plugged into the car.
IS_MOVING
BOOLEAN
-
-
-
when changed
Signal if vehicle is moving or not moving.
NETWORK_CELL_INFO
STRING
-
-
-
when changed
identifier of the base station to which the dongle is connecetd. format: MCC;MNC;LAC;CellId
POSITION
GEO
-
-
60
interval or direction change
Vehicle position from GPS.
REBOOT_RESPONSE
STRING
-
-
-
Signal when dongle starts reboot and finished rebooting.
TIME_TO_FIRST_FIX
STRING
-
-
-
gps fix
Time until modul got a gnss fix.

Vehicle Specific / OEM Data Events

Event Type
Data Type
Unit
Unit ID
Interval
Trigger
Description
AMBIENT_AIR_TEMPERATURE
NUMBER
°C
30
60
interval
Ambient air temperature.
AVERAGE_FUEL_CONSUMPTION
NUMBER
l
90
300
interval, later when changed
Average fuel consumption
BATTERY_STATE
STRING
-
-
-
when changed
Current battery state.
CURRENT_FUEL_CONSUMPTION
NUMBER
l
90
300
interval, later when changed
Current fuel consumption
DISTANCE_FROM_INSPECTION
NUMBER
km
111
-
interval, later once per trip
Distance since last inspection.
DISTANCE_MIL_ON
NUMBER
km
111
300
when changed
Distance since the MIL is on.
DISTANCE_SINCE_CODES_CLEARED
NUMBER
km
111
60
when changed
Distance since dtc cleared.
ENGINE_COOLANT_TEMPERATURE
NUMBER
°C
30
60
interval
Engine coolant temperature from OBD.
ENGINE_LOAD_AVERAGE
NUMBER
%
20
60
interval
Average engine load in the the last time interval.
ENGINE_LOAD_MAX
NUMBER
%
20
60
interval
Max engine load in the the last time interval.
ENGINE_LOAD_MIN
NUMBER
%
20
60
interval
Min engine load in the the last time interval.
ENGINE_OIL_TEMPERATURE
NUMBER
°C
30
60
interval, later when changed
Engine oil temperature.
ENGINE_RPM_AVERAGE
NUMBER
1/min
241
60
interval
Average rpm in the the last time interval.
ENGINE_RPM_MAX
NUMBER
1/min
241
60
interval
Max rpm in the the last time interval.
ENGINE_RPM_MIN
NUMBER
1/min
241
60
interval
Min rpm in the the last time interval.
ENGINE_RUN_TIME
NUMBER
s
160
60
interval
Time since engine is on in seconds.
FUEL_LEVEL
NUMBER
l
90
300
interval, later when changed
Fuel level.
FUEL_LEVEL_PERCENT
NUMBER
%
20
60
interval, later when changed
Fuel level in percent.
FUEL_RATE_AVERAGE
NUMBER
l/h
191
60
interval, later when changed
Current fuel rate by the vehicle.
FUEL_RATE_MAX
NUMBER
l/h
191
60
Max fuel rate in the the last time interval.
FUEL_RATE_MIN
NUMBER
l/h
191
60
interval
Min fuel rate in the the last time interval.
FUEL_TYPE
TEXT
-
-
-
GREEN_RPM_PERCENTAGE
NUMBER
%
20
60
interval
Green rpm score in the the last time interval.
HV_BATTERY_CHARGING_CURRENT
NUMBER
A
50
-
HV_BATTERY_CHARGING_DURATION
NUMBER
min
163
60
interval, later when changed
HV_BATTERY_CHARGING_POWER
NUMBER
%
20
60
interval, later when changed
HV_BATTERY_CHARGING_STATUS
STRING
-
-
300
interval, later when changed
Current charging status (loading/not loading).
HV_BATTERY_IS_CHARGING
BOOLEAN
-
-
-
when changed
HV_BATTERY_NOMINAL_ENERGY_CAPACITY
NUMBER
kWh
373
60
interval
Total capacity of the high voltage battery when new
HV_BATTERY_REMAINING_CHARGE
NUMBER
Ah
200
60
interval
Current charge level of the high voltage battery in Ah
HV_BATTERY_REMAINING_CHARGING_DURATION
NUMBER
s
160
60
interval
Time remaining until the high voltage battery will be fully charged
HV_BATTERY_REMAINING_DISTANCE
NUMBER
%
20
300
interval, later when changed
Remaining distance for the electric vehicle.
HV_BATTERY_REMAINING_ENERGY
NUMBER
kWh
373
60
interval
Current charge level of the high voltage battery in kWh
HV_BATTERY_REMAINING_RANGE
NUMBER
km
111
60
interval, later when changed
HV_BATTERY_SOC
NUMBER
%
20
300
interval, later when changed
State of charge (SoC) of the high voltage battery for electric vehicles.
HV_BATTERY_SOH
NUMBER
%
20
60
interval, later when changed
Hybrid vehicles remaining battery life.
HV_BATTERY_STATUS
STRING
-
-
60
interval, later when changed
State of battery.
HV_BATTERY_TEMPERATURE
NUMBER
°C
30
60
interval, later when changed
Temperature of hv battery
HV_BATTERY_TOTAL_CAPACITY
NUMBER
Ah
200
60
interval, later when changed
HV_BATTERY_VOLTAGE
NUMBER
V
40
60
interval
Total voltage for all cells together
INSPECTION_REMAINING_DISTANCE
NUMBER
km
111
-
interval, later once per trip
Remaining distance until next inspection.
INSPECTION_REMAINING_TIME
NUMBER
d
165
-
interval, later once per trip
Remaining time until next inspection.
IS_ENGINE_ON
BOOLEAN
-
-
-
when changed
Signal if engine is turned on or off.
IS_GPS_SWITCH_ON
BOOLEAN
-
-
-
when changed
Current state of the gps switch.
IS_IGNITION_ON
BOOLEAN
-
-
-
when changed
Signal if ignition is turned on or off.
IS_MIL_ON
BOOLEAN
-
-
-
when changed
Signal if MIL is on or off.
IS_OIL_LEVEL_OK
BOOLEAN
-
-
300
interval, later when changed
Current oil level status.
MAX_DISTANCE_UNTIL_INSPECTION
NUMBER
km
111
-
interval, later once per trip
Max distance until inspection.
MAX_TIME_UNTIL_INSPECTION
NUMBER
d
165
-
interval, later once per trip
Max time until inspection.
MILEAGE
NUMBER
km
111
300
interval, later when changed
Odometer distance.
OBD_CALIBRATION_ID
STRING
-
-
-
first trip
Calibration id of the ecu.
OBD_CALIBRATION_VERIFICATION_NUMBER
STRING
-
-
-
first trip
Calibration verification number of the ecu.
OBD_DTC_COUNT
NUMBER
10
-
when changed
Amount of OBD error codes.
OBD_DTC_PERMANENT
STRING
-
-
-
when changed
Static OBD2 error codes.
OBD_DTC_SPORADIC
STRING
-
-
-
when changed
Sporadically OBD2 error codes.
OIL_CHANGE_REMAINING_DISTANCE
NUMBER
km
111
-
interval, later once per trip
Remaining distance until next oil change.
OIL_CHANGE_REMAINING_TIME
NUMBER
d
165
-
interval, later once per trip
Remaining time until next oil change.
OIL_LEVEL
NUMBER
mm
113
300
interval, later when changed
Current oil level.
OIL_WARNING_THRESHOLD
NUMBER
mm
113
300
interval, later once per trip
Oil level warning threshold.
SERVICE_EXCEEDED_DISTANCE
NUMBER
km
111
300
interval, later once per trip
Distance exceeded since last necessary service.
SERVICE_EXCEEDED_TIME
NUMBER
d
165
300
interval, later once per trip
Time exceeded since last necessary service.
THROTTLE_POSITION_AVERAGE
NUMBER
%
20
60
interval
Average throttle position in the the last time interval.
THROTTLE_POSITION_MAX
NUMBER
%
20
60
interval
Max throttle position in the the last time interval.
THROTTLE_POSITION_MIN
NUMBER
%
20
60
interval
Min throttle position in the the last time interval.
TIME_FROM_INSPECTION
NUMBER
d
165
-
interval, later once per trip
Time since last inspection.
VEHICLE_SPEED_AVERAGE
NUMBER
km/h
121
60
interval
Average vehicle speed in the the last time interval.
VEHICLE_SPEED_MAX
NUMBER
km/h
121
60
interval
Max vehicle speed in the the last time interval.
VEHICLE_SPEED_MIN
NUMBER
km/h
121
60
interval
Min vehicle speed in the the last time interval.
VIN
STRING
-
-
-
first trip
Vehicle identification number.
WARNING_OVERSPEEDING
NUMBER
km/h
121
60
interval
Warning because high vehicle speed detected.
WARNING_RPM
NUMBER
1/min
241
60
interval
Warning because of high RPM detected.
WARNING_THROTTLE_POSITION
NUMBER
%
20
60
interval
Warning because high throttle position detected.

Schemas

Event

Base class or interface Event which holds the common properties recordedTimestamp, deviceId, eventType and dataType.


deviceId:
integer($int64)
The IMEI of the device.
recordedTimestamp:
string($date-time)
The timestamp when the event has been recorded.
dataType:
string
Type of value encoding (STRING, BOOLEAN, NUMBER, GEO).
eventType:
string
Indicates which event is encoded.

Device

A device object contains the basic properties of the OBD dongle.


id:
integer($int64)
The id of the device, i.e. the IMEI.
manufacturer:
string
The hardware manufacturer of the device, i.e. autoaid.
hardwareType:
string
The hardware type of the device.
hardwareVersion:
string
The hardware version of the device.
firmwareVersion:
string
The software version which is currently running on the device.
isOnline:
boolean
A flag indicating whether the device is currently sending data.
isPluggedIn:
boolean
A flag indicating whether the device is currently installed.
vehicleId:
string
The id of the vehicle in which the device has been installed.
tripId:
string
The id of the trip that is currently in progress.
modifyTimestamp:
string($date-time)
The timestamp, when the device status has changed.

{
    "id": 861359038274344,
    "manufacturer": "autoaid",
    "hardwareType": "dongle",
    "hardwareVersion": "C5",
    "firmwareVersion": "1 Aug 16 2019",
    "isOnline": true,
    "isPluggedIn": true,
    "vehicleId": "VINYV1ZW25UDK1332944",
    "tripId": "90f228de5c611c7148d5",
    "modifyTimestamp": "2020-02-03T13:58:46.775Z"
}

Vehicle

Vehicle object containing basic data like make or model together with a snapshot of the latest events grouped by eventType.


id:
string
The id of the vehicle (usually the VIN with the prefix 'VIN', otherwise the IMEI of the device with the prefix 'IMEI_').
vin:
string
The vehicle identification number (VIN) of the vehicle.
tecDocMakeId:
integer($int32)
The make id of the vehicle from the TecDoc database.
tecDocModelId:
integer($int32)
The model id of the vehicle from the TecDoc database.
tecDocVehicleId:
integer($int32)
The vehicle id from the TecDoc database if known (usually 0).
make:
string
The name of the vehicle manufacturer.
model:
string
The name of the vehicle model.
vehicle:
string
The detailed name of the vehicle containing engine specific data (usually empty).
fuelType:
string
The fuel type of the vehicle if it can be determined.
kba:
string
The number of German KBA that uniquely identifies the vehicle (usally empty).
licensePlate:
string
The license plate of the vehicle, if it has been configured.
deviceId:
integer($int64)
The IMEI of the device which is currently installed in the vehicle.
tripId:
string
The id of the current trip. This field is empty when the car is not driving.
lastEvents:
Event []
A snapshot of the latest events grouped by eventType.
modifyTimestamp:
string($date-time)
The timestamp, when the vehicle status has changed.

{
    "id": "VINYV1ZW25UDK1332944",
    "vin": "YV1ZW25UDK1332944",
    "tecDocMakeId": 120,
    "tecDocModelId": 38603,
    "tecDocVehicleId": 0,
    "make": "VOLVO",
    "model": "V60 II (225)",
    "vehicle": "T5",
    "fuelType": "Petrol",
    "kba": "0588AHA",
    "licensePlate": "B-AA 896",
    "deviceId": 861359033310655,
    "tripId": "90f228de5c611c7148d5",
    "lastEvents": [
        {
            "deviceId": 861359038274344,
            "recordedTimestamp": "2019-11-28T18:51:20.815Z",
            "eventType": "MILEAGE",
            "dataType": "NUMBER",
            "value": 35538,
            "unit": "km",
            "unitId": 111
        }
    ],
    "modifyTimestamp": "2019-11-28T18:51:20.815Z"
}

Trip

Trip object containing basic data duration, distance, address data of start and end position.


id:
string
Identifier of the trip.
vehicleId:
string
Vehicle identifier of the trip.
tripStartAddress:
Address
Address object with details to the start position of a trip.
tripEndAddress:
Address
Address object with details to the end position of a trip.
distance:
float
The driven distance of a trip in km.
duration:
integer($int32)
The time how long the trip was, calculated in seconds.
tripStartTimestamp:
string($date-time)
The timestamp when the trip has been started.
tripEndTimestamp:
string($date-time)
The timestamp when the trip has been stopped.
aggregations:
[] Aggregation
List of aggregated events.

deleteTimestamp:
string($date-time)
The timestamp, when the trip was marked as deleted.
modifyTimestamp:
string($date-time)
The timestamp, when the trip status has changed.
{
    "id": "30b80666a025b5eb41bx",
    "deviceId": 861359038274344,
    "vehicleId": "VINYV1ZW25UDK1332944",
    "tripStartAddress": {
        "id": "20e116de5c633c8148ff",
        "road": "Helmholtzstra\u00dfe",
        "houseNumber": "2-9",
        "suburb": "Charlottenburg",
        "locality": "Berlin",
        "state": "Berlin",
        "country": "Germany",
        "postcode": "10587",
        "lat": 52.520374,
        "lon": 13.32426
    },
    "tripEndAddress": {
        "id": "20e116de5c633c8148ff",
        "road": "Helmholtzstra\u00dfe",
        "houseNumber": "2-9",
        "suburb": "Charlottenburg",
        "locality": "Berlin",
        "state": "Berlin",
        "country": "Germany",
        "postcode": "10587",
        "lat": 52.520374,
        "lon": 13.32426
    },
    "distance": 60,
    "duration": 3600,
    "tripStartTimestamp": "2020-02-03T13:00:00.775Z",
    "tripEndTimestamp": "2020-02-03T14:00:00.775Z",
    "aggregations": [
        {
            "eventType": "MILEAGE",
            "dataType": "NUMBER",
            "aggregationType": "START",
            "value": 32100,
            "unit_id": 111,
            "unit": "km"
        },
        {
            "eventType": "MILEAGE",
            "dataType": "NUMBER",
            "aggregationType": "END",
            "value": 32160,
            "unit_id": 111,
            "unit": "km"
        },
        {
            "eventType": "POSITION",
            "dataType": "STRING",
            "aggregationType": "POLYLINE",
            "value": "oufn_BwdqnO_AaG`Ij@b]k@jFyY_AykCkL}m@e]gk@gc@q`@c[mPqf@aO}m@kHq{"
        }
    ],
    "deleteTimestamp": null,
    "modifyTimestamp": "2020-02-03T14:00:00.775Z"
}

Address

Address object containing related data to a geo position.


id:
string
Identifier of the address.
road:
string
Translated road related to the start or end position of a trip.
houseNumber:
string
Translated house number related to the start or end position of a trip.
suburb:
string
Translated suburb related to the start or end position of a trip.
locality:
string
Translated locality related to the start or end position of a trip.
state:
string
Translated state related to the start or end position of a trip.
country:
boolean
Translated country related to the start or end position of a trip.
postcode:
string
Translated postcode related to the start or end position of a trip.
lat:
number($float)
Latitude value of the start or end position of a trip.
lon:
number($float)
Longitude value of the start or end position of a trip.
{
    "id": "20e116de5c633c8148ff",
    "road": "Helmholtzstra\u00dfe",
    "houseNumber": "2-9",
    "suburb": "Charlottenburg",
    "locality": "Berlin",
    "state": "Berlin",
    "country": "Germany",
    "postcode": "10587",
    "lat": 52.520374,
    "lon": 13.32426
}

Aggregation

Aggregation object containing different statistics of events such as min, max, average etc. The values are grouped and aggregated into "bins" of equal size depending on the selected time interval (DAY, MONTH, YEAR).


vehicleId:
string
Identifier of the vehicle.
eventType:
string
Type of the aggregated event like MILEAGE, FUEL_LEVEL, POSITION
dataType:
string
Data type of the aggregated event.
aggregationType:
string
Available types are MIN, MAX, AVG, DIFFERENCE, START, END
value:
string
Aggregated value.
unitId:
integer
Id of the unit.
unit:
string
Unit of the value
bin:
string($date-time)
The timestamp on which the aggregations are grouped.
{
    "vehicleId": "VINYV1ZW25UDK1332944",
    "eventType": "MILEAGE",
    "dataType": "NUMBER",
    "aggregationType": "DIFFERENCE",
    "value": 200.5,
    "unit": "km",
    "unitId": 111,
    "bin": "2019-07-01T00:00:00"
}

DTC

Object containing basic data to a diagnostic trouble code (DTC).


id:
string
Identifier of the fault code.
vehicleId:
string
Vehicle identifier.
deviceId:
integer($int64)
Device identifier (IMEI).
ecuTypeId:
integer($int32)
Identifier of the Electronic Control Unit (ECU).
ecuType:
string
Translated name of the Electronic Control Unit (ECU) like Engine Control Unit.
code:
string
Diagnostic Trouble Code (DTC).
encoded
string
Encoded representation of the Diagnostic Trouble Code.
encoding:
string
Type of encoding. Possible values are HEX, DECIMAL, PCODE
label:
string
Translated fault code text.
dtcType:
string
Type of the fault code. Possible values are PERMANENT, SPORADIC, FREEZEFRAME
recordedTimestamp:
string($date-time)
The timestamp, when the fault code was captured.
{
    "id": "ee7184fd3a71548cf773",
    "vehicleId": "VINYV1ZW25UDK1332944",
    "deviceId": 861359033310655,
    "ecuTypeId": 91,
    "ecuType": "Engine Control Module (ECM)",
    "code": "3DE3",
    "encoded": "3DE3",
    "encoding": "HEX",
    "label": "DC/DC BOOST MODE LOW VOLTAGE SIDE",
    "dtcType": "Permanent",
    "recordedTimestamp": "2020-09-02T16:49:18.805Z",
    "deleteTimestamp": null,
    "modifyTimestamp": "2020-09-02T16:49:18.864196Z"
}

AMBIENT AIR TEMPERATURE

Ambient air temperature.


eventType:
AMBIENT_AIR_TEMPERATURE
dataType:
NUMBER
unit:
°C
unitId:
30
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "AMBIENT_AIR_TEMPERATURE",
    "dataType": "NUMBER",
    "unit": "°C",
    "unitId": 30,
    "value": 18,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

AVERAGE FUEL CONSUMPTION

Average fuel consumption


eventType:
AVERAGE_FUEL_CONSUMPTION
dataType:
NUMBER
unit:
l
unitId:
90
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "AVERAGE_FUEL_CONSUMPTION",
    "dataType": "NUMBER",
    "unit": "l",
    "unitId": 90,
    "value": 7.5,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

BATTERY STATE

Current battery state.


eventType:
BATTERY_STATE
dataType:
STRING
value:
string
Loading
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "BATTERY_STATE",
    "dataType": "STRING",
    "value": "Loading",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

BATTERY VOLTAGE

Battery voltage value.


eventType:
BATTERY_VOLTAGE
dataType:
NUMBER
unit:
V
unitId:
40
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "BATTERY_VOLTAGE",
    "dataType": "NUMBER",
    "unit": "V",
    "unitId": 40,
    "value": 12.5,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

CURRENT FUEL CONSUMPTION

Current fuel consumption


eventType:
CURRENT_FUEL_CONSUMPTION
dataType:
NUMBER
unit:
l
unitId:
90
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "CURRENT_FUEL_CONSUMPTION",
    "dataType": "NUMBER",
    "unit": "l",
    "unitId": 90,
    "value": 45.81,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

DISTANCE FROM INSPECTION

Distance since last inspection.


eventType:
DISTANCE_FROM_INSPECTION
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "DISTANCE_FROM_INSPECTION",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 3800,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

DISTANCE MIL ON

Distance since the MIL is on.


eventType:
DISTANCE_MIL_ON
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "DISTANCE_MIL_ON",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

DISTANCE SINCE CODES CLEARED

Distance since dtc cleared.


eventType:
DISTANCE_SINCE_CODES_CLEARED
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "DISTANCE_SINCE_CODES_CLEARED",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 6510,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

DRIVEN DISTANCE

Driven distance since last report.


eventType:
DRIVEN_DISTANCE
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "DRIVEN_DISTANCE",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 0.289,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE COOLANT TEMPERATURE

Engine coolant temperature from OBD.


eventType:
ENGINE_COOLANT_TEMPERATURE
dataType:
NUMBER
unit:
°C
unitId:
30
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_COOLANT_TEMPERATURE",
    "dataType": "NUMBER",
    "unit": "°C",
    "unitId": 30,
    "value": 90,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE LOAD AVERAGE

Average engine load in the the last time interval.


eventType:
ENGINE_LOAD_AVERAGE
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_LOAD_AVERAGE",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 38,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE LOAD MAX

Max engine load in the the last time interval.


eventType:
ENGINE_LOAD_MAX
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_LOAD_MAX",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 52,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE LOAD MIN

Min engine load in the the last time interval.


eventType:
ENGINE_LOAD_MIN
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_LOAD_MIN",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 10,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE OIL TEMPERATURE

Engine oil temperature.


eventType:
ENGINE_OIL_TEMPERATURE
dataType:
NUMBER
unit:
°C
unitId:
30
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_OIL_TEMPERATURE",
    "dataType": "NUMBER",
    "unit": "°C",
    "unitId": 30,
    "value": 75,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE RPM AVERAGE

Average rpm in the the last time interval.


eventType:
ENGINE_RPM_AVERAGE
dataType:
NUMBER
unit:
1/min
unitId:
241
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_RPM_AVERAGE",
    "dataType": "NUMBER",
    "unit": "1/min",
    "unitId": 241,
    "value": 1620,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE RPM MAX

Max rpm in the the last time interval.


eventType:
ENGINE_RPM_MAX
dataType:
NUMBER
unit:
1/min
unitId:
241
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_RPM_MAX",
    "dataType": "NUMBER",
    "unit": "1/min",
    "unitId": 241,
    "value": 2120,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE RPM MIN

Min rpm in the the last time interval.


eventType:
ENGINE_RPM_MIN
dataType:
NUMBER
unit:
1/min
unitId:
241
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_RPM_MIN",
    "dataType": "NUMBER",
    "unit": "1/min",
    "unitId": 241,
    "value": 900,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

ENGINE RUN TIME

Time since engine is on in seconds.


eventType:
ENGINE_RUN_TIME
dataType:
NUMBER
unit:
s
unitId:
160
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "ENGINE_RUN_TIME",
    "dataType": "NUMBER",
    "unit": "s",
    "unitId": 160,
    "value": 1040,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

FIRMWARE VERSION

Current firmware of the dongle.


eventType:
FIRMWARE_VERSION
dataType:
STRING
value:
string
22 Jul 2019
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "FIRMWARE_VERSION",
    "dataType": "STRING",
    "value": "22 Jul 2019",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

FUEL LEVEL

Fuel level.


eventType:
FUEL_LEVEL
dataType:
NUMBER
unit:
l
unitId:
90
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "FUEL_LEVEL",
    "dataType": "NUMBER",
    "unit": "l",
    "unitId": 90,
    "value": 13.5,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

FUEL LEVEL PERCENT

Fuel level in percent.


eventType:
FUEL_LEVEL_PERCENT
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "FUEL_LEVEL_PERCENT",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 16,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

FUEL RATE AVERAGE

Current fuel rate by the vehicle.


eventType:
FUEL_RATE_AVERAGE
dataType:
NUMBER
unit:
l/h
unitId:
191
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "FUEL_RATE_AVERAGE",
    "dataType": "NUMBER",
    "unit": "l/h",
    "unitId": 191,
    "value": 30.5,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

FUEL RATE MAX

Max fuel rate in the the last time interval.


eventType:
FUEL_RATE_MAX
dataType:
NUMBER
unit:
l/h
unitId:
191
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "FUEL_RATE_MAX",
    "dataType": "NUMBER",
    "unit": "l/h",
    "unitId": 191,
    "value": 9.2,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

FUEL RATE MIN

Min fuel rate in the the last time interval.


eventType:
FUEL_RATE_MIN
dataType:
NUMBER
unit:
l/h
unitId:
191
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "FUEL_RATE_MIN",
    "dataType": "NUMBER",
    "unit": "l/h",
    "unitId": 191,
    "value": 4,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

FUEL TYPE


eventType:
FUEL_TYPE
dataType:
TEXT
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "FUEL_TYPE",
    "dataType": "TEXT",
    "value": "",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

GPS ALTITUDE

Current height in meters.


eventType:
GPS_ALTITUDE
dataType:
NUMBER
unit:
m
unitId:
110
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "GPS_ALTITUDE",
    "dataType": "NUMBER",
    "unit": "m",
    "unitId": 110,
    "value": 44,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

GPS COURSE

Current course in degree.


eventType:
GPS_COURSE
dataType:
NUMBER
unit:
°
unitId:
60
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "GPS_COURSE",
    "dataType": "NUMBER",
    "unit": "\u00b0",
    "unitId": 60,
    "value": 316,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

GPS HDOP

Accuracy of the gps positions.


eventType:
GPS_HDOP
dataType:
NUMBER
unit:
unitId:
10
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "GPS_HDOP",
    "dataType": "NUMBER",
    "unit": "",
    "unitId": 10,
    "value": 1.1105,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

GPS SATELLITES IN USE

Current gnss satellites in view.


eventType:
GPS_SATELLITES_IN_USE
dataType:
NUMBER
unit:
unitId:
10
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "GPS_SATELLITES_IN_USE",
    "dataType": "NUMBER",
    "unit": "",
    "unitId": 10,
    "value": 9,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

GPS SATELLITES IN VIEW

Current gnss satellites in use.


eventType:
GPS_SATELLITES_IN_VIEW
dataType:
NUMBER
unit:
unitId:
10
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "GPS_SATELLITES_IN_VIEW",
    "dataType": "NUMBER",
    "unit": "",
    "unitId": 10,
    "value": 21,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

GPS SPEED

Current speed in kmh.


eventType:
GPS_SPEED
dataType:
NUMBER
unit:
km/h
unitId:
121
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "GPS_SPEED",
    "dataType": "NUMBER",
    "unit": "km/h",
    "unitId": 121,
    "value": 56,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

GREEN RPM PERCENTAGE

Green rpm score in the the last time interval.


eventType:
GREEN_RPM_PERCENTAGE
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "GREEN_RPM_PERCENTAGE",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 90,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY CHARGING CURRENT


eventType:
HV_BATTERY_CHARGING_CURRENT
dataType:
NUMBER
unit:
A
unitId:
50
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_CHARGING_CURRENT",
    "dataType": "NUMBER",
    "unit": "A",
    "unitId": 50,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY CHARGING DURATION


eventType:
HV_BATTERY_CHARGING_DURATION
dataType:
NUMBER
unit:
min
unitId:
163
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_CHARGING_DURATION",
    "dataType": "NUMBER",
    "unit": "min",
    "unitId": 163,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY CHARGING POWER


eventType:
HV_BATTERY_CHARGING_POWER
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_CHARGING_POWER",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY CHARGING STATUS

Current charging status (loading/not loading).


eventType:
HV_BATTERY_CHARGING_STATUS
dataType:
STRING
value:
string
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_CHARGING_STATUS",
    "dataType": "STRING",
    "value": "",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY IS CHARGING


eventType:
HV_BATTERY_IS_CHARGING
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_IS_CHARGING",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY NOMINAL ENERGY CAPACITY

Total capacity of the high voltage battery when new


eventType:
HV_BATTERY_NOMINAL_ENERGY_CAPACITY
dataType:
NUMBER
unit:
kWh
unitId:
373
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_NOMINAL_ENERGY_CAPACITY",
    "dataType": "NUMBER",
    "unit": "kWh",
    "unitId": 373,
    "value": 60,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY REMAINING CHARGE

Current charge level of the high voltage battery in Ah


eventType:
HV_BATTERY_REMAINING_CHARGE
dataType:
NUMBER
unit:
Ah
unitId:
200
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_REMAINING_CHARGE",
    "dataType": "NUMBER",
    "unit": "Ah",
    "unitId": 200,
    "value": 124.3,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY REMAINING CHARGING DURATION

Time remaining until the high voltage battery will be fully charged


eventType:
HV_BATTERY_REMAINING_CHARGING_DURATION
dataType:
NUMBER
unit:
s
unitId:
160
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_REMAINING_CHARGING_DURATION",
    "dataType": "NUMBER",
    "unit": "s",
    "unitId": 160,
    "value": 7638,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY REMAINING DISTANCE

Remaining distance for the electric vehicle.


eventType:
HV_BATTERY_REMAINING_DISTANCE
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_REMAINING_DISTANCE",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY REMAINING ENERGY

Current charge level of the high voltage battery in kWh


eventType:
HV_BATTERY_REMAINING_ENERGY
dataType:
NUMBER
unit:
kWh
unitId:
373
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_REMAINING_ENERGY",
    "dataType": "NUMBER",
    "unit": "kWh",
    "unitId": 373,
    "value": 37.4,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY REMAINING RANGE


eventType:
HV_BATTERY_REMAINING_RANGE
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_REMAINING_RANGE",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY SOC

State of charge (SoC) of the high voltage battery for electric vehicles.


eventType:
HV_BATTERY_SOC
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_SOC",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY SOH

Hybrid vehicles remaining battery life.


eventType:
HV_BATTERY_SOH
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_SOH",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 40,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY STATUS

State of battery.


eventType:
HV_BATTERY_STATUS
dataType:
STRING
value:
string
Being charged
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_STATUS",
    "dataType": "STRING",
    "value": "Being charged",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY TEMPERATURE

Temperature of hv battery


eventType:
HV_BATTERY_TEMPERATURE
dataType:
NUMBER
unit:
°C
unitId:
30
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_TEMPERATURE",
    "dataType": "NUMBER",
    "unit": "°C",
    "unitId": 30,
    "value": 11,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY TOTAL CAPACITY


eventType:
HV_BATTERY_TOTAL_CAPACITY
dataType:
NUMBER
unit:
Ah
unitId:
200
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_TOTAL_CAPACITY",
    "dataType": "NUMBER",
    "unit": "Ah",
    "unitId": 200,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

HV BATTERY VOLTAGE

Total voltage for all cells together


eventType:
HV_BATTERY_VOLTAGE
dataType:
NUMBER
unit:
V
unitId:
40
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "HV_BATTERY_VOLTAGE",
    "dataType": "NUMBER",
    "unit": "V",
    "unitId": 40,
    "value": 234,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IMSI

Sim card imsi id.


eventType:
IMSI
dataType:
STRING
value:
string
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IMSI",
    "dataType": "STRING",
    "value": "",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

INSPECTION REMAINING DISTANCE

Remaining distance until next inspection.


eventType:
INSPECTION_REMAINING_DISTANCE
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "INSPECTION_REMAINING_DISTANCE",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 25400,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

INSPECTION REMAINING TIME

Remaining time until next inspection.


eventType:
INSPECTION_REMAINING_TIME
dataType:
NUMBER
unit:
d
unitId:
165
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "INSPECTION_REMAINING_TIME",
    "dataType": "NUMBER",
    "unit": "d",
    "unitId": 165,
    "value": 285,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IS DONGLE IN STANDBY

Signal if dongle is in standby mode or leaving standby mode.


eventType:
IS_DONGLE_IN_STANDBY
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IS_DONGLE_IN_STANDBY",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IS DONGLE PLUGGED IN

Signal if the dongle is plugged into the car.


eventType:
IS_DONGLE_PLUGGED_IN
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IS_DONGLE_PLUGGED_IN",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IS ENGINE ON

Signal if engine is turned on or off.


eventType:
IS_ENGINE_ON
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IS_ENGINE_ON",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IS GPS SWITCH ON

Current state of the gps switch.


eventType:
IS_GPS_SWITCH_ON
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IS_GPS_SWITCH_ON",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IS IGNITION ON

Signal if ignition is turned on or off.


eventType:
IS_IGNITION_ON
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IS_IGNITION_ON",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IS MIL ON

Signal if MIL is on or off.


eventType:
IS_MIL_ON
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IS_MIL_ON",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IS MOVING

Signal if vehicle is moving or not moving.


eventType:
IS_MOVING
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IS_MOVING",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

IS OIL LEVEL OK

Current oil level status.


eventType:
IS_OIL_LEVEL_OK
dataType:
BOOLEAN
value:
boolean
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "IS_OIL_LEVEL_OK",
    "dataType": "BOOLEAN",
    "value": true,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

MAX DISTANCE UNTIL INSPECTION

Max distance until inspection.


eventType:
MAX_DISTANCE_UNTIL_INSPECTION
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "MAX_DISTANCE_UNTIL_INSPECTION",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 30000,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

MAX TIME UNTIL INSPECTION

Max time until inspection.


eventType:
MAX_TIME_UNTIL_INSPECTION
dataType:
NUMBER
unit:
d
unitId:
165
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "MAX_TIME_UNTIL_INSPECTION",
    "dataType": "NUMBER",
    "unit": "d",
    "unitId": 165,
    "value": 365,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

MILEAGE

Odometer distance.


eventType:
MILEAGE
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "MILEAGE",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 22141,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

NETWORK CELL INFO

identifier of the base station to which the dongle is connecetd. format: MCC;MNC;LAC;CellId


eventType:
NETWORK_CELL_INFO
dataType:
STRING
value:
string
262;01;5126;42198
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "NETWORK_CELL_INFO",
    "dataType": "STRING",
    "value": "262;01;5126;42198",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OBD CALIBRATION ID

Calibration id of the ecu.


eventType:
OBD_CALIBRATION_ID
dataType:
STRING
value:
string
31491231AA
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OBD_CALIBRATION_ID",
    "dataType": "STRING",
    "value": "31491231AA",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OBD CALIBRATION VERIFICATION NUMBER

Calibration verification number of the ecu.


eventType:
OBD_CALIBRATION_VERIFICATION_NUMBER
dataType:
STRING
value:
string
C805A6B7
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OBD_CALIBRATION_VERIFICATION_NUMBER",
    "dataType": "STRING",
    "value": "C805A6B7",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OBD DTC COUNT

Amount of OBD error codes.


eventType:
OBD_DTC_COUNT
dataType:
NUMBER
unit:
unitId:
10
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OBD_DTC_COUNT",
    "dataType": "NUMBER",
    "unit": "",
    "unitId": 10,
    "value": 2,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OBD DTC PERMANENT

Static OBD2 error codes.


eventType:
OBD_DTC_PERMANENT
dataType:
STRING
value:
string
P1702
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OBD_DTC_PERMANENT",
    "dataType": "STRING",
    "value": "P1702",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OBD DTC SPORADIC

Sporadically OBD2 error codes.


eventType:
OBD_DTC_SPORADIC
dataType:
STRING
value:
string
U1602
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OBD_DTC_SPORADIC",
    "dataType": "STRING",
    "value": "U1602",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OIL CHANGE REMAINING DISTANCE

Remaining distance until next oil change.


eventType:
OIL_CHANGE_REMAINING_DISTANCE
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OIL_CHANGE_REMAINING_DISTANCE",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 26260,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OIL CHANGE REMAINING TIME

Remaining time until next oil change.


eventType:
OIL_CHANGE_REMAINING_TIME
dataType:
NUMBER
unit:
d
unitId:
165
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OIL_CHANGE_REMAINING_TIME",
    "dataType": "NUMBER",
    "unit": "d",
    "unitId": 165,
    "value": 31,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OIL LEVEL

Current oil level.


eventType:
OIL_LEVEL
dataType:
NUMBER
unit:
mm
unitId:
113
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OIL_LEVEL",
    "dataType": "NUMBER",
    "unit": "mm",
    "unitId": 113,
    "value": 61.82,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

OIL WARNING THRESHOLD

Oil level warning threshold.


eventType:
OIL_WARNING_THRESHOLD
dataType:
NUMBER
unit:
mm
unitId:
113
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "OIL_WARNING_THRESHOLD",
    "dataType": "NUMBER",
    "unit": "mm",
    "unitId": 113,
    "value": 48.5,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

POSITION

Vehicle position from GPS.


eventType:
POSITION
dataType:
GEO
value:
object
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "POSITION",
    "dataType": "GEO",
    "value": "POINT(13.428973 52.515955)",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

REBOOT RESPONSE

Signal when dongle starts reboot and finished rebooting.


eventType:
REBOOT_RESPONSE
dataType:
STRING
value:
string
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "REBOOT_RESPONSE",
    "dataType": "STRING",
    "value": "",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

SERVICE EXCEEDED DISTANCE

Distance exceeded since last necessary service.


eventType:
SERVICE_EXCEEDED_DISTANCE
dataType:
NUMBER
unit:
km
unitId:
111
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "SERVICE_EXCEEDED_DISTANCE",
    "dataType": "NUMBER",
    "unit": "km",
    "unitId": 111,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

SERVICE EXCEEDED TIME

Time exceeded since last necessary service.


eventType:
SERVICE_EXCEEDED_TIME
dataType:
NUMBER
unit:
d
unitId:
165
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "SERVICE_EXCEEDED_TIME",
    "dataType": "NUMBER",
    "unit": "d",
    "unitId": 165,
    "value": 0,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

THROTTLE POSITION AVERAGE

Average throttle position in the the last time interval.


eventType:
THROTTLE_POSITION_AVERAGE
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "THROTTLE_POSITION_AVERAGE",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 15,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

THROTTLE POSITION MAX

Max throttle position in the the last time interval.


eventType:
THROTTLE_POSITION_MAX
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "THROTTLE_POSITION_MAX",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 40,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

THROTTLE POSITION MIN

Min throttle position in the the last time interval.


eventType:
THROTTLE_POSITION_MIN
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "THROTTLE_POSITION_MIN",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 10,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

TIME FROM INSPECTION

Time since last inspection.


eventType:
TIME_FROM_INSPECTION
dataType:
NUMBER
unit:
d
unitId:
165
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "TIME_FROM_INSPECTION",
    "dataType": "NUMBER",
    "unit": "d",
    "unitId": 165,
    "value": 10,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

TIME TO FIRST FIX

Time until modul got a gnss fix.


eventType:
TIME_TO_FIRST_FIX
dataType:
STRING
value:
string
Coldstart 30537ms
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "TIME_TO_FIRST_FIX",
    "dataType": "STRING",
    "value": "Coldstart 30537ms",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

VEHICLE SPEED AVERAGE

Average vehicle speed in the the last time interval.


eventType:
VEHICLE_SPEED_AVERAGE
dataType:
NUMBER
unit:
km/h
unitId:
121
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "VEHICLE_SPEED_AVERAGE",
    "dataType": "NUMBER",
    "unit": "km/h",
    "unitId": 121,
    "value": 43,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

VEHICLE SPEED MAX

Max vehicle speed in the the last time interval.


eventType:
VEHICLE_SPEED_MAX
dataType:
NUMBER
unit:
km/h
unitId:
121
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "VEHICLE_SPEED_MAX",
    "dataType": "NUMBER",
    "unit": "km/h",
    "unitId": 121,
    "value": 59,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

VEHICLE SPEED MIN

Min vehicle speed in the the last time interval.


eventType:
VEHICLE_SPEED_MIN
dataType:
NUMBER
unit:
km/h
unitId:
121
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "VEHICLE_SPEED_MIN",
    "dataType": "NUMBER",
    "unit": "km/h",
    "unitId": 121,
    "value": 40,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

VIN

Vehicle identification number.


eventType:
VIN
dataType:
STRING
value:
string
TMBJB9NZ2A2012345
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "VIN",
    "dataType": "STRING",
    "value": "TMBJB9NZ2A2012345",
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

WARNING OVERSPEEDING

Warning because high vehicle speed detected.


eventType:
WARNING_OVERSPEEDING
dataType:
NUMBER
unit:
km/h
unitId:
121
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "WARNING_OVERSPEEDING",
    "dataType": "NUMBER",
    "unit": "km/h",
    "unitId": 121,
    "value": 190,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

WARNING RPM

Warning because of high RPM detected.


eventType:
WARNING_RPM
dataType:
NUMBER
unit:
1/min
unitId:
241
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "WARNING_RPM",
    "dataType": "NUMBER",
    "unit": "1/min",
    "unitId": 241,
    "value": 4600,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}

WARNING THROTTLE POSITION

Warning because high throttle position detected.


eventType:
WARNING_THROTTLE_POSITION
dataType:
NUMBER
unit:
%
unitId:
20
value:
float
deviceId:
integer($int64)
recordedTimestamp:
string($date-time)
{
    "eventType": "WARNING_THROTTLE_POSITION",
    "dataType": "NUMBER",
    "unit": "%",
    "unitId": 20,
    "value": 94,
    "deviceId": 861359038274344,
    "recordedTimestamp": "2019-07-10T09:20:01.999Z"
}