Create Fault

Create a new Fault Record. If you need to create many Faults at once, use the Bulk API to avoid Rate Limiting errors.

application/json

Request Body

vehicle_id integer required
Possible values: >= 1
code string required
Possible values: <= 255 characters
The diagnostic trouble code. Must correspond with an existing Fault Rule.
count integer
The number of times this Fault has occurred.
description string
A short description about the problem.
external_id string
Possible values: <= 255 characters
An external identifier for the Fault, if applicable.
last_occurred_at date-time
The date and time when the Fault last occurred. We recommend using ISO-8601 formatted dates to avoid ambiguity.
name string
Possible values: <= 255 characters
The name or label for the Fault.
status string
Possible values: [open, resolved, ignored]
The status of the Fault.
source string
The source or origin of the Fault.

Responses

Response Headers

application/json

Schema
Example (from schema)

Schema

id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
account_id integer
Possible values: >= 1
vehicle_id NullableId
Possible values: >= 1
code string
The diagnostic trouble code.
count integer
The number of times this Fault has occurred.
description string
A short description about the problem.
external_id string
An external identifier for the Fault, if applicable.
last_occurred_at date-time
The date and time when the Fault last occurred.
name string
The name or label for the Fault.
status string
Possible values: [open, resolved, ignored]
Default value: open
The status of the Fault.
source string
The source or origin of the Fault.
vehicle_archived_at date-time
The date and time when the associated Vehicle was archived, if applicable.
fault_rule_id NullableId
Possible values: >= 1
is_sample boolean
Indicates if the Fault is sample data.
idempotency_key string
An optional key for idempotent operations.

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "vehicle_id": 0,
  "code": "string",
  "count": 0,
  "description": "string",
  "external_id": "string",
  "last_occurred_at": "2023-03-14T13:46:27-06:00",
  "name": "string",
  "status": "open",
  "source": "string",
  "vehicle_archived_at": "2023-03-14T13:46:27-06:00",
  "fault_rule_id": 0,
  "is_sample": true,
  "idempotency_key": "string"
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Unprocessable Entity

application/json

Schema
Example (from schema)
Example

Schema

errors object
type
items string

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}