GET /vehicle/<id> |
This service is used to retrieve the details of a specific vehicle. The vehicle is identified by its ID, which is added as the last part of the URL. Odometer readings are in miles.
Note |
---|
TDE returns only vehicles to which the user has access. If you request a vehicle Id to which you lack access permission, you will get an error. |
No request body is required for this service.
On success, the response body contains the JSON object that represents a vehicle:
Member | Type | Purpose | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
id | string | Uniquely identifies the vehicle. This is an integer identifier. | |||||||||
tag | string | The name of the vehicle, as a human-readable string. | |||||||||
make | string | The manufacturer of the vehicle, as a human-readable string. | |||||||||
model | string | The manufacturer's model of the vehicle, as a human-readable string. | |||||||||
year | int | The manufacturer's year of the vehicle. | |||||||||
odometer | double | The current odometer reading for the vehicle, in miles. | |||||||||
engineHours | int | The current engine usage reading of the vehicle, in hours. | |||||||||
marker | string | The home base of the vehicle. | |||||||||
licensePlate | string | The current license plate number of the vehicle. | |||||||||
driverId | string | The Id of the driver that is currently assigned to the vehicle. | |||||||||
devices | Device[] | The devices (unit types) installed in the vehicle.
|
|||||||||
vin | string | The VIN (vehicle identification number) of the vehicle. | |||||||||
custom | JSON object | Contains one or more key-value pairs for any custom fields and values defined for the vehicle. The items returned for this object can vary between vehicles. |