v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

List the vehicle's fault codes

get/v1/fault_codes

Query parameters

eld_device_ids[]integer[]

Specify the IDs of the Vehicle Gateways for whom you want to fetch the vehicle fault codes.

vehicle_ids[]integer[]

Specify the IDs of the vehicles for whom you want to fetch the fault codes.

statusstring

Specify the status of the fault codes to filter the report. Possible values are open and closed.

typestring

Specify the type of the fault codes. Possible values are constant and intermittent.

start_datestring date

Specify the start date for the report. Default: TODAY - 7 DAYS AGO

end_datestring date

Specify the end date for the report. Default: TODAY

per_pageinteger

Number of records to return per page.

page_nointeger

Current page number.

updated_afterstring date

Specify the date after which the fault codes were updated.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

Response

200

per_pageinteger

page_nointeger

totalinteger

Example response

{
  "fault_codes": [
    {
      "fault_code": {
        "id": 48401,
        "code": "P203F",
        "code_label": "P203F",
        "code_description": "Reductant Level Too Low",
        "source_address_label": "2024",
        "status": "closed",
        "first_observed_at": "2024-03-07T15:46:56Z",
        "last_observed_at": "2024-03-07T19:45:27Z",
        "type": "constant",
        "num_observations": 46,
        "sum_num_observations": 175,
        "source_address": "2024",
        "eld_device": {
          "id": 91429,
          "identifier": "AABL36RC400066",
          "model": "lbb-3.6ca"
        },
        "vehicle": {
          "id": 126207,
          "number": "MTV_Prev_AABL36RC400066",
          "vin": "JTHBK1GGXF2187111",
          "metric_units": true
        },
        "network": "obdii"
      }
    }
  ],
  "per_page": 25,
  "page_no": 1,
  "total": 2
}