driver

A driver represents the person who is servicing a route. To assign drivers to routes, set route.driver.

Name Type Description
attributes string[] The attributes provided by this driver. Use this with job.required_driver_attributes and job.disallowed_driver_attributes. See Routing with Attributes.
centroid marker or id Optional. A driver's centroid defines an area with a soft boundary, around a single location. A centroid's area can change depending on the number of jobs and the number of drivers available. It provides a hint to the optimizer that this driver's routes should be clustered around the specified location. A centroid is different from a zone which has a hard boundary. Can be supplied as an inline marker, or the id of a marker defined elsewhere in the request. Also known as "advanced territories" and "gravity points". Also see zones.
cost_per_hour float The default number of US$ per hour worked for this driver. Used for optimization. Defaults to the value of cost_per_hour.
custom custom Optional. User-supplied custom fields that are returned unmodified in the response. These have no effect on optimization.
end_location marker or id The default end location for this driver's routes, or the id of a marker defined elsewhere in the request.
first_name string Optional. The first name of the driver.
id id The unique ID of the driver.
last_name string Optional. The last name of the driver.
location marker or id A convenience field that sets both start_location and end_location.
max_multiday_days integer The maximum length (in days) of a multi-day route for this driver. Defaults to the value of max_multiday_days (if this value is set); otherwise defaults to 1 (no multi-day routes). See Routing with Multi-day Routes.
middle_name string Optional. The middle name of the driver.
name string Optional. A display name for the driver.
overtime_cost_per_hour float The default number of US$ per overtime hour worked for this driver. Overtime hours occur when a route's duration exceeds normal_working_time. Used for optimization. Defaults to overtime_cost_per_hour (if this value is set); otherwise defaults to 1.5 × cost_per_hour.
shift_overrides shift_override[] Optional. A list of shift overrides that are used when instantiating routes.
shift_patterns shift_pattern_assignment[] Optional. A list of shift patterns that are used for this driver when instantiating routes.
start_location marker or id The default start location for this driver's routes, or the id of a marker defined elsewhere in the request.
vehicle vehicle or id If provided, the preferred vehicle for this driver. The optimizer will attempt to assign this vehicle to all of the driver's routes during a build.

Example

{
    "id": "driver0",
    "max_multiday_days": 5,
    "centroid": "39.714796, -105.106698"
}

See Also