The Diagnostic API allows you to retrieve diagnostic information and DTCs (Diagnostic Trouble Code) reported by the OBD system of your vehicle. A DTC is an alphanumeric code used to identify vehicle problems. For example, the DTC C1446 indicates a brake switch circuit failure.
The API response contains information such as the diagnostic code, definition of the code, vehicle name, location, and timestamp.
Diagnostic information of multiple vehicles can be obtained in a single API call.
Sample Request
{
"vehicleIds":[
"ad965910-3685-11e5-b8e2-c5b6a804c369",
"cc24608d-dc14-11e4-bf2b-435f55649c28"
],
"fromDate":"2016-06-20 00:00:00",
"toDate":"2016-06-21 23:59:00"
}API Response explanation
Field | Description |
|---|---|
code | API Status Code |
message | API Message (Success/Failure) |
reason | Reason for failure |
generatedAt | API generation timestamp in UTC |
dtcMessageId | Message ID (internal reference) |
vehicle | Name of the vehicle |
address | Address of the location where the DTC was generated |
DateTime | DTC generation timestamp in milliseconds |
code | Diagnostic troubleshooting code (DTC) reported by the vehicle |
deviceId | Unique identifier of the device plugged into the vehicle |
description | Simple description for the DTC |
assetno | Asset number of the vehicle |
firstName | First name of the driver |
lastName | Last name of the driver |
parentGroup | Parent of the vehicle’s group |
lat | Latitude coordinate of the location where the DTC was generated |
lng | Longitude coordinate of the location where the DTC was generated |
foreParentGroup | Fore parent of the vehicle’s group |
offset | Time offset in minutes |
displayTimeZone | Timezone of the vehicle |
group | Name of the vehicle’s group |