> ## Documentation Index
> Fetch the complete documentation index at: https://docs.connectedfleet.michelin.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Vehicle Faults
> Returns the faults on a vehicle. If no parameters are specified, then only vehicles with an active fault are returned. An active fault has no endDate.
If groupId is specified, then all vehicles in the specified group are included in the output. If vehicleId is specified, then only the specified vehicle is included in the output. Either vehicleId or groupId can be specified as an input parameter, an error is returned if both are specified.
If startDate is specified, then only those vehicles where the fault was detected on or after the specified date are returned. If endDate is not specified, then the startDate cannot be more than 90 days before today’s date. If endDate is specified then startDate must also be specified. endDate cannot be before startDate and the date range between startDate and endDate cannot be more than 90 days.
If there are more than 20 vehicles to return, then by default only the first 20 vehicles are returned. To view details of the other vehicles you will need to specify values for pageSize and pageIndex.
## OpenAPI
````yaml https://api.connectedfleet.michelin.com/fleet-management/api-docs get /public/v1/customer/{customerId}/vehicle/faults
openapi: 3.0.1
info:
title: Fleet management
description: >-
A comprehensive administration pack enabling full control over fleet
structures, users, drivers, vehicles and operational data.
contact:
name: Masternaut
url: https://www.masternaut.com
email: support@masternautconnect.com
version: 124.0.2607160821
servers:
- url: https://api.connectedfleet.michelin.com/fleet-management
description: Product Server
security:
- bearerAuth: []
tags:
- name: /driver
description: Driver Operations
- name: /group
description: Group operations
- name: /location/category
description: Location category management operations
- name: /location
description: Location management operations
- name: /role
description: Role operations
- name: /tokenInformation
description: Token operations
- name: /user
description: User operations
- name: /maintenance
description: Vehicle maintenance operations
- name: /vehicle
description: Vehicle management operations
paths:
/public/v1/customer/{customerId}/vehicle/faults:
get:
tags:
- /maintenance
- /vehicle
summary: Vehicle Faults
description: >-
Returns the faults on a vehicle. If no parameters are specified, then
only vehicles with an active fault are returned. An active fault has no
endDate.
If groupId is specified, then all vehicles in the
specified group are included in the output. If vehicleId is specified,
then only the specified vehicle is included in the output. Either
vehicleId or groupId can be specified as an input parameter, an error is
returned if both are specified.
If startDate is specified, then
only those vehicles where the fault was detected on or after the
specified date are returned. If endDate is not specified, then the
startDate cannot be more than 90 days before today’s date. If endDate is
specified then startDate must also be specified. endDate cannot be
before startDate and the date range between startDate and endDate cannot
be more than 90 days.
If there are more than 20 vehicles to
return, then by default only the first 20 vehicles are returned. To view
details of the other vehicles you will need to specify values for
pageSize and pageIndex.
operationId: searchVehiclesWithFaults
parameters:
- name: customerId
in: path
required: true
schema:
type: string
- name: pageIndex
in: query
description: >-
Specifies the pagination page index.
Pages are zero indexed,
i.e. the first page has an index value of zero.
required: false
schema:
type: integer
description: >-
Specifies the pagination page index.
Pages are zero indexed,
i.e. the first page has an index value of zero.
format: int32
- name: pageSize
in: query
description: >-
Specifies the number of items to include on a page.
Must be
specified if pageIndex has been specified.
required: false
schema:
type: integer
description: >-
Specifies the number of items to include on a page.
Must be
specified if pageIndex has been specified.
format: int32
- name: startDate
in: query
required: false
schema:
type: string
format: date-time
- name: endDate
in: query
required: false
schema:
type: string
format: date-time
- name: vehicleId
in: query
required: false
schema:
type: string
- name: groupId
in: query
required: false
schema:
type: string
responses:
'200':
description: Vehicles were successfully returned.
content:
application/json;charset=UTF-8:
schema:
$ref: >-
#/components/schemas/WithPaginationResultVehicleSearchResultWithFaultsDto
'400':
description: >-
Missing validation on parameters - when endDate is before startDate,
both vehicleId and groupId are specified, startDate is not in the
past, date range exceeds 90 days, or endDate specified without
startDate.
'404':
description: No vehicles found for the specified criteria
components:
schemas:
WithPaginationResultVehicleSearchResultWithFaultsDto:
type: object
properties:
totalPages:
type: integer
description: Total number of pages based on the pageSize.
format: int32
totalCount:
type: integer
description: Total number of items that matched the search parameters.
format: int64
items:
type: array
description: Array of items.
items:
$ref: '#/components/schemas/VehicleSearchResultWithFaultsDto'
VehicleSearchResultWithFaultsDto:
type: object
properties:
id:
type: string
groupName:
type: string
groupId:
type: string
make:
type: string
model:
type: string
version:
type: string
driverId:
type: string
faults:
type: array
items:
$ref: '#/components/schemas/VehicleSearchResultFaultDto'
name:
type: string
registration:
type: string
description: Array of items.
VehicleSearchResultFaultDto:
type: object
properties:
description:
type: string
code:
type: string
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
startOdometer:
type: number
format: double
endOdometer:
type: number
format: double
type:
type: string
inProgress:
type: boolean
details:
$ref: '#/components/schemas/FaultDetailsResultDto'
FaultDetailsResultDto:
type: object
properties:
source:
type: string
sourceDescription:
type: string
occurrenceCount:
type: integer
format: int32
fmi:
type: string
fmiDescription:
type: string
lamps:
type: array
items:
type: string
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````