GET /drivers/{id}
Retrieves the Driver record with the given ID.
Roles that can access this endpoint are Users, Drivers.
Parameters
| name |
description |
type |
default |
type |
| id |
ID for the driver to be returned |
path
|
|
String
|
| includeComments |
if related Comment records should be included |
query
|
false |
Boolean
|
| includeContacts |
if related Contact records should be included |
query
|
false |
Boolean
|
| includeLanes |
if related RowDriverLane records should be included |
query
|
false |
Boolean
|
Result
RowDriver
of type:
application/xml
application/json
the requested RowDriver record
Additional attributes:
__returnHomeFlagDescr This value represents the description of the return home flag, found in the driver.return_home_flag field.__sexDescr This value represents the description of the driver's sex, found in the driver.sex field.__teamStatusDescr This value represents the description of the driver's team status, found in the driver.team_status field.__typeOfDescr This value represents the description of the driver type, found in the driver.type_of field.__currentMovementId This value represents the ID of the driver's current movement.
Child Elements:
RowLocation This element represent the location associated with the driver's home location, by the driver.home_location_id field.
The element contains a __name attribute with the value homeLocation.RowUsers This element represent the fleet manager user associated with the driver by the driver.fleet_manager field.
The element contains a __name attribute with the value fleetManager.RowContact These elements represent the contacts associated with the driver.
The element contains a __name attribute with the value contacts.
*Note this is only returned if the includeContacts Query Parameter is passed as true.RowComments These elements represent the comments associated with the driver.
The element contains a __name attribute with the value comments.
*Note this is only returned if the includeComments Query Parameter is passed as true.RowDriverLane These elements represent the lane exclusions associated with the driver.
The element contains a __name attribute with the value lanes.
*Note this is only returned if the includeLanes Query Parameter is passed as true.
Try It Out
Request