This service lets users who are authorized to assign drivers to vehicles retrieve the list of available vehicles. (No vehicles are returned to those lacking this authorization.) Using the list of vehicles that are currently available, the user can then assign one to the driver who is logged in.
The service returns units in the order by which they are most likely to be selected: first by the driver's current assignment (if any), then by those at the driver's depot, then by other depots within the driver's territory. Within each of these groups, units are ordered by Tag.
No request body is used for this service.
On success, the response is a JSON array of objects, where each object represents a vehicle:
|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.|