Sign in

v1

latestOpenAPI 3.1.02026-07-22370342.6 KB
Fault Codes

List Fault Code Events

List all fault code events detected by the provider.

get/fault-codes/events

Query parameters

cursorstring cursor
Example:cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw

Pagination cursor to start requests from

limitinteger

The maximum number of results to return in a page.

modifiedAfterstring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified after a provided date.

modifiedBeforestring date-time
Example:2021-01-06T03:24:53.000Z

Only include records that were last modified before a provided date.

startAtstring date-time

ISO 8601 date

Example:2021-01-06T03:24:53.000Z

Only include fault code events after a provided date.

endAtstring date-time

ISO 8601 date

Example:2021-01-06T03:24:53.000Z

Only include fault code events before a provided date.

vehicleIdsstring

Comma separated list of vehicle IDs to filter for. Can filter up to 50 vehicles at a time. Each ID must use the vcl_ prefix.

expand'vehicle'

Expand resources in the returned response

rawboolean

Include raw responses used to normalize model. Used for debugging or accessing unique properties that are not unified.

Headers

X-Application-Idstring

Scopes the request to a Terminal application in the caller's organization. Required for multi-application organizations when using a user session or OAuth access token. API keys are already bound to a single application.

Connection-Tokenstring required
Example:con_tkn_22vUhkC6tgre4kwaYfUkCDA1rzn6eyb4

The token returned when a user authenticated their account. This authorizes access to a specific account.

Response

OK

nextstring cursor

Cursor used for pagination.

Example response

{
  "results": [
    {
      "id": "fc_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "provider": "geotab",
      "vehicle": "vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC",
      "code": "P0087",
      "description": "Fuel Rail/System Pressure - Too Low Bank 1",
      "observedAt": "2021-01-06T03:24:53.000Z",
      "obdii": {
        "code": "P0087",
        "description": "Fuel Rail/System Pressure - Too Low Bank 1"
      },
      "j1939": {
        "fmi": 9,
        "fmiDescription": "Voltage Below Normal",
        "spn": 3031,
        "spnDescription": "System Diagnostic Code #1",
        "occurrenceCount": 15,
        "sourceAddress": 256
      },
      "raw": []
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"
}