shift_override

A shift_override represents a deviation from a driver's usual shift_pattern for a specified date range. Shift overrides can be provided on a driver, or on the problem to be applied to all drivers. If a driver has an override on the same day that a problem-level override is in effect, the problem-level override is ignored.

During the instantiate process, if there are any shift overrides in effect on a given day the override shift is instantiated instead of any shifts specified by the shift pattern.

Name Type Description
end_date date Required. The date of the final day that this shift override will be in effect for the driver.
id id Unique ID of the shift override.
shift shift or id Optional. The shift to be worked for each day in the specified date range. If set to null this represents a day off.
start_date date Required. The date of the first day that this shift override will take effect.

Example

{
  "id": "oct-1 afternoon override",
  "start_date": "2017-01-01",
  "end_date": "2017-01-01",
  "shift": {
    "id": "shift0",
    "start_time": "12:00",
    "end_time": "20:00"
  }
}

A shift override for one day on January 1, with a shift running from 12:00 PM to 8:00 PM.

See Also