> ## 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.
# List Vehicle
> Returns the registration, group and current odometer reading for a vehicle. The odometer reading is in kilometres. If no parameters are specified, then details for all vehicles are returned.Input parameters that can be specified are:- groupIds - all vehicles in the specified groups are included in the output
- vehicleIds - only the specified vehicles are included in the output
- name - only the vehicle with the specified name is included in the output.
Only one of vehicleIds, groupIds or name can be specified as an input parameter, an error is returned if more than one parameter is specified.
## OpenAPI
````yaml /api-reference/fleet-management.json get /public/v1/customer/{customerId}/vehicle
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.masternautconnect.com/connect-webservices/services
description: Product Server
security:
- basicAuth: []
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:
get:
tags:
- /vehicle
summary: List Vehicle
description: >-
Returns the registration, group and current odometer reading for a
vehicle. The odometer reading is in kilometres. If no parameters are
specified, then details for all vehicles are returned.Input parameters
that can be specified are:- groupIds - all vehicles in the
specified groups are included in the output
- vehicleIds - only
the specified vehicles are included in the output
- name - only
the vehicle with the specified name is included in the
output.
Only one of vehicleIds, groupIds or name can be
specified as an input parameter, an error is returned if more than one
parameter is specified.
operationId: searchVehicles
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: vehicleIds
in: query
description: Comma separated list of vehicle identifiers (alphanumeric).
required: false
schema:
type: array
description: Comma separated list of vehicle identifiers (alphanumeric).
items:
type: string
- name: groupIds
in: query
description: Comma separated list of group identifiers (alphanumeric).
required: false
schema:
type: array
description: Comma separated list of group identifiers (alphanumeric).
items:
type: string
- name: registration
in: query
description: Vehicle registration number
required: false
schema:
type: string
description: Vehicle registration number
- name: name
in: query
description: Friendly name of a vehicle
required: false
schema:
type: string
description: Friendly name of a vehicle
- name: activeOnly
in: query
description: Filter to return only active vehicles
required: false
schema:
type: boolean
description: Filter to return only active vehicles
responses:
'200':
description: Vehicles were successfully returned.
content:
application/json;charset=UTF-8:
schema:
$ref: >-
#/components/schemas/WithPaginationResultVehicleSearchResultDto
'400':
description: Missing validation on parameters.
components:
schemas:
WithPaginationResultVehicleSearchResultDto:
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/VehicleSearchResultDto'
VehicleSearchResultDto:
type: object
properties:
id:
type: string
description: Unique vehicle identifier
registration:
type: string
description: Vehicle registration number
name:
type: string
description: Vehicle friendly name
type:
type: string
description: Vehicle type
groupId:
type: string
description: >-
Unique, unchangeable system generated identifier (alphanumeric) of
the group assigned to the vehicle.
groupName:
type: string
description: Name of the group assigned to the vehicle.
odometerValue:
type: number
description: Odometer (in km) at the end of the last journey.
format: double
odometerType:
type: string
description: Either GPS or CAN.
make:
type: string
description: Make of the vehicle.
model:
type: string
description: Model of the vehicle.
tags:
type: array
description: >-
Comma separated list of tags for the vehicle.
Not returned if
there are no tags for this vehicle.
items:
type: string
featureTags:
type: array
description: Feature tags associated with the vehicle
items:
type: string
defaultDriverId:
type: string
description: >-
Default driver identifier (alphanumeric) for this vehicle.
Not
returned if there is no default driver for this vehicle.
tempDriverId:
type: string
description: Temporary driver identifier assigned to the vehicle
status:
type: string
description: >-
Status of the vehicle.
Can be one of the following: ●
IN_CIRCULATION = Vehicle is active ● IN_MAINTENANCE = Vehicle is off
the road for maintenance ● SOLD = Vehicle has been sold
assetCosts:
$ref: '#/components/schemas/VehicleCostsDto'
idlingFidelity:
type: integer
description: >-
The type of idling that can be detected on the vehicle.
Values
are: 0 = Idling is not supported, 1 = Idling is detected when the
vehicle is stationary, 2 = Idling is detected when the vehicle is
stationary and the engine is running
format: int32
energyType:
type: string
description: >-
The energy type for the vehicle.
Can be one of the following:
- UNDEFINED
- EV - Battery Electric Vehicle
- PHEV
- Plug-in Hybrid Electric Vehicle
- HEV - Hybrid Electric
Vehicle
- FECV - Fuel Cell Electric Vehicle
(Hydrogen)
- ICE - Internal combustion engine
- CNG -
Compressed Natural Gas
- LNG - Liquefied natural
gas
- LPG - Liquefied petroleum gas
- BI-FUEL -
multi-fuel engines capable of running on two fuels.
fuelType:
type: array
description: >-
A list of the primary and secondary fuel types for the
vehicle.
Values in the list can include:
- PETROL
- DIESEL
- PROPANE
- METHANE
- ELECTRIC
- HYDROGEN
items:
type: string
engineTotalHours:
type: number
description: >-
Engine hours for the latest tracking event that has been received
(format is decimal hours)
format: float
engineTotalHoursType:
type: string
description: >-
Either ESTIMATED or CAN.
CAN indicates the engineTotalHours
value has been read from the vehicle's CANbus, ESTIMATED indicates
the engineTotalHours value has been calculated from the total
vehicle journey times.
enum:
- CAN
- ESTIMATED
engineTotalHoursLastModified:
type: string
description: Last modified timestamp for engine total hours
format: date-time
odometerLastModified:
type: string
description: Last modified timestamp for odometer value
format: date-time
assetTypeGroup:
type: string
description: Asset type group category for the vehicle
serialNumber:
type: integer
description: >-
The serial number of the tracking device on the vehicle that sends
tracking events
format: int64
activeFaultCodes:
type: array
description: Comma separated list of active fault codes on the vehicle.
items:
type: string
secondaryGroups:
type: array
description: Secondary groups associated with the vehicle
items:
$ref: '#/components/schemas/IdNameDto'
description: Array of items.
VehicleCostsDto:
type: object
properties:
yearOfManufacture:
type: integer
description: Year the vehicle was manufactured.
format: int32
ownershipStartDate:
type: string
description: Start date of vehicle ownership.
format: date
ownershipEndDate:
type: string
description: End date of vehicle ownership.
format: date
purchaseCost:
type: number
description: Purchase cost of the vehicle.
monthlyLeaseCost:
type: number
description: Monthly lease cost for the vehicle.
monthlyInsuranceCost:
type: number
description: Monthly insurance cost for the vehicle.
monthlyMaintenanceCost:
type: number
description: Monthly maintenance cost for the vehicle.
scheduledMaintenanceAmount:
type: number
description: Amount budgeted for scheduled maintenance.
unscheduledMaintenanceAmount:
type: number
description: Cost incurred for unscheduled maintenance.
monthlyFuelCost:
type: number
description: Estimated monthly fuel cost for the vehicle.
mileageAuthorised:
type: integer
description: Authorized mileage limit for the vehicle.
format: int32
costPerMileOverLimit:
type: number
description: Cost per mile when exceeding authorized mileage.
costOfDisposal:
type: number
description: Cost associated with vehicle disposal.
buyoutAmount:
type: number
description: Buyout amount for leased vehicle.
costCurrency:
type: string
description: Currency code for all cost values.
description: >-
Vehicle cost information including purchase, lease, maintenance, and
operational costs.
IdNameDto:
type: object
properties:
id:
type: string
description: Unique identifier of the entity (alphanumeric)
name:
type: string
description: Display name of the entity. Not returned if empty
description: Simple identifier and name pair for groups, vehicles, or other entities.
securitySchemes:
basicAuth:
type: http
scheme: basic
````