get https://api.gomotive.com/v1/fault_codes
Purpose: Use this endpoint to fetch a list of all the vehicle's fault codes. Fault codes derived from the Vehicle Gateways are diagnostic trouble codes that are generated by a vehicle's onboard computer. These codes indicate various problems such as engine malfunctions, emissions, system failures, or sensor issues.
Use this report to monitor vehicle health, perform preventive maintenance, and ensure vehicle safety and compliance.
require 'uri'
require 'net/http'
url = URI('https://api.gomotive.com/v1/fault_codes')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request['Authorization'] = "Bearer <OAUTH_TOKEN>"
response = http.request(request)
puts response.read_body
Response Parameters
id
- Type: Integer
- Description: Unique identifier for the fault code.
code
- Type: String
- Description: The fault code as reported by the vehicle.
code_label
- Type: String
- Description: Label associated with the fault code.
code_description
- Type: String
- Description: Description of the fault code.
source_address_label
- Type: String
- Description: Label for the source address from which the fault code originated.
status
- Type: String
- Description: Status of the fault code (e.g., open, closed).
first_observed_at
- Type: String
- Description: The date and time when the fault code was first observed.
last_observed_at
- Type: String
- Description: The date and time when the fault code was last observed.
type
- Type: String
- Description: Type of the fault code (e.g., constant).
fmi
- Type: String
- Description: Failure Mode Identifier, providing additional detail about the fault.
occurrence_count
- Type: Integer
- Description: Number of times the fault code has occurred.
num_observations
- Type: Integer
- Description: The number of observations of the fault code.
sum_num_observations
- Type: Integer
- Description: The cumulative number of observations for the fault code.
source_address_name
- Type: String
- Description: Name associated with the source address of the fault code.
source_address
- Type: String
- Description: Source address from which the fault code originated.
is_sid
- Type: Boolean
- Description: Indicates whether the code is a System Identification Number (SID).
fmi_description
- Type: String
- Description: Description of the Failure Mode Identifier.
dtc_status
- Type: String
- Description: Status of the Diagnostic Trouble Code.
dtc_severity
- Type: String
- Description: Severity of the Diagnostic Trouble Code.
functional_grp_id
- Type: Integer
- Description: Functional group identifier.
ftb
- Type: String
- Description: Fault code Trouble Board identifier.
id
- Type: Integer
- Description: Unique identifier for the Vehicle Gateway.
identifier
- Type: String
- Description: The identifier of the Vehicle Gateway.
model
- Type: String
- Description: The model of the Vehicle Gateway.
id
- Type: Integer
- Description: Unique identifier for the vehicle associated with the fault code.
number
- Type: String
- Description: The vehicle number.
year
- Type: String
- Description: The manufacturing year of the vehicle.
make
- Type: String
- Description: The make of the vehicle.
model
- Type: String
- Description: The model of the vehicle.
vin
- Type: String
- Description: The VIN (Vehicle Identification Number) of the vehicle.
metric_units
- Type: Boolean
- Description: Indicates if the vehicle uses metric units.
network
- Type: String
- Description: Network through which the fault code was communicated (e.g., obdii).