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) |
messageCode | For Azuga internal use |
generatedAt | API generation timestamp in UTC |
vehicle | Name of the vehicle |
group | Name of the vehicle’s group |
dateTime | DTC generation timestamp in milliseconds |
firstName | First name of the driver |
lastName | Last name of the driver |
parentGroup | Parent of the vehicle’s group |
vehicleId | Unique identifier representing the vehicle |
make | Make of the vehicle |
model | Model of the vehicle |
year | Year of the vehicle |
displayTimeZone | Timezone of the vehicle |
offset | Time offset in minutes |
address | Address of the location where the DTC was generated |
code | Diagnostic troubleshooting code (DTC) reported by the vehicle |
description | Short text describing the DTC |
lat | Latitude coordinate of the location where the DTC was generated |
lng | Longitude coordinate of the location where the DTC was generated |
spnCode | Suspect Parameter Number code |
fmiCode | Failure Mode Identifier code |
repairImportance | The priority at which the problem is to be fixed. Categorized as high, medium, and low |
severityLevel | The severity of the problem from a repair difficulty perspective. Categorized as hard, moderate, and easy |
detailedDescription | Detailed description of the problem |
symptoms | Indication of the problem |
possibleCauses | Potential reasons that could have led the problem |
customerId | Unique identifier representing the customer |
dtcMessageId | Message ID (internal reference) |