DTC History (Diagnostic Trouble Codes History)

A history of the list of diagnostic trouble codes that hint at potential errors or technical faults for a vehicle with a given VIN.

Name: dtchistory

Delivery Method: pull

ATTRIBUTES

fromDate required
string undefined
toDate required
string undefined
history required
object undefined
timestamp
string The timestamp the DTC History was retrieved. Format according to ISO 8601 format.
{
  "name": "DTC History (Diagnostic Trouble Codes History)",
  "technicalName": "dtchistory",
  "description": "A history of the list of diagnostic trouble codes that hint at potential errors or technical faults for a vehicle with a given VIN.",
  "lifecycleStatus": "PUBLISHED",
  "type": "IN_VEHICLE",
  "personalData": false,
  "schema": {
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "title": "DTC History (Diagnostic Trouble Codes History)",
  "required": [
    "fromDate",
    "toDate",
    "history"
  ],
  "properties": {
    "fromDate": {
      "type": "string",
      "format": "date"
    },
    "toDate": {
      "type": "string",
      "format": "date"
    },
    "history": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "messageTimestamp": {
            "type": "string",
            "format": "date-time"
          },
          "receivedTimestamp": {
            "type": "string",
            "format": "date-time"
          },
          "id": {
            "type": "string"
          },
          "mileage": {
            "type": "object",
            "properties": {
              "dataPoint": {
                "type": "object",
                "properties": {
                  "value": {
                    "type": "number"
                  },
                  "unit": {
                    "type": "string"
                  },
                  "timestamp": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "required": ["value", "unit", "timestamp"]
              }
            },
            "required": ["dataPoint"]
          },
          "alerts": {
            "type": ["array", "null"],
            "items": {
              "type": "object",
              "properties": {
                "alertType": {
                  "type": "string"
                },
                "wilCode": {
                  "type": "string"
                },
                "dtcCode": {
                  "type": ["string", "null"]
                },
                "failureType": {
                  "type": ["string", "null"]
                },
                "symptomKey": {
                  "type": "number"
                },
                "customerActionKey": {
                  "type": "number"
                },
                "ecumaps": {
                  "type": ["object", "null"]
                }
              }
            }
          },
          "warnings": {
            "type": ["array", "null"],
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string"
                }
              }
            }
          },
          "dtcs": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "dtcId": {
                  "type": "string"
                },
                "ecuId": {
                  "type": "string"
                },
                "ecuStatus": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                },
                "failureType": {
                  "type": "string"
                },
                "timestamp": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          }
        }
      }
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "title": "The timestamp the DTC History was retrieved. Format according to ISO 8601 format."
    }
  }
}