Skip to main content
Vehicle errors are representations of (timestamped) fault conditions detected in vehicles, reported through the VehicleError model. Errors are matched with error definitions whenever possible.

Vehicle error structure

A vehicle error has the following structure:
{
    "id": "verr_01jv4nr7n4f6bbty91fagdwn83",  // Unique vehicle error ID in TypeID format.
    "vehicle_id": "veh_01jnk61e5pf6zs5ag6483xqe43",  // The vehicle the error is associated with.
    "error_definition_id": "errdef_01jnk621baffebddn635bnwwmc", // The matched error definition ID, if available.
    "ticket_ids": [],
    "status": "OPEN",  // Status of the error: OPEN, CLOSED
    "timestamp_opened": "2025-05-13T11:15:58.000000+0000",
    "timestamp_closed": null,
    "device_id": null,
    "error_code": null,
    "error_code_user": "BAT-LOW",
    "revision": "1.1",
    "device_category_id": "VEHICLE",
    "severity": "ERROR",
    "notification_priority": "HIGH",
    "extra_info": null
}
The data may be supplied by the error ingestion mechanism (via IoT device or HTTP endpoints), or automatically added from the respective error definition.
I