Skip to main content
​
protocol
enum<string>
required

The diagnostic protocol used

Available options:
j1939,
obdii
Allowed value: "obdii"
​
id
string<ulid>
required
Example:

"fc_evt_01D8ZQFGHVJ858NBF2Q7DV9MNC"

​
provider
string
required

Every provider has a unique code to identify it across Terminal's system. You can find each provider's code under provider details.

Example:

"geotab"

​
vehicle
required

Entities in Terminal are expandable. Using the expand query parameter you can choose to ingest just an ID or the full entity details.

Example:

"vcl_01D8ZQFGHVJ858NBF2Q7DV9MNC"

​
status
enum<string>
required

The status of the fault code at the time of the event. Some providers do not report closed statuses.

Available options:
open,
pending,
closed
​
code
string
required

The fault code identifier. For OBD-II systems: alphanumeric DTC codes (P0087, U0046, C0123, B1234). For J1939 systems: SPN-FMI format (SPN3031-FMI9) or derived codes from SPN/FMI combinations.

Example:

"P0087"

​
observedAt
string<date-time>
required

ISO 8601 date

Example:

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

​
obdii
object
required

OBD-II Diagnostic Trouble Code information for light/medium duty vehicles. Contains standardized alphanumeric codes like P0087, U0046, C0123, B1234.

​
metadata
EntityMetadata · object
required

Internal metadata about the record.

​
description
string

Human-readable description of the fault

Example:

"Fuel Rail/System Pressure - Too Low Bank 1"

​
milStatus
enum<string>

The Malfunction Indicator Lamp (MIL) status of the vehicle at the time the fault code was observed

Available options:
on,
off
​
j1939
object

J1939 fault code information for heavy-duty vehicles. FMI (Failure Mode Identifier) indicates the specific nature of the fault (0-31 numeric codes).

​
raw
RawData · object[]
Example:
[]