shift_pattern
A shift_pattern
represents a recurring sequence of shifts worked by a driver.
Shift patterns can be used to instantiate routes to be used in a build.
Name | Type | Description |
---|---|---|
custom | custom | User-supplied custom fields that are returned unmodified in the response. These have no effect on optimization. |
id | id | Unique ID of the shift pattern. |
name | string | The name of the shift pattern. |
shifts | shift[][] or id[][] | A day-by-day listing of arrays of shifts for this pattern. Each array represents a single day containing zero or more shifts. An empty array can be used to represent a day off. |
Example
{
"id": "pattern0",
"shifts": [
[{ "id": "day0", "start_time": "09:00" }],
[{ "id": "day1_shift0", "start_time": "03:00", "end_time": "09:00"}, { "id": "day_shift1", "start_time": "12:00" }],
[]
]
}
See Also
- The shift type.
- The shift_pattern_assignment type.
- The instantiate endpoint.