• Home
  • Guides
  • Reference
  • Support

    Show / Hide Table of Contents
    • API Overview
      • Overview
      • Authentication
      • Retrieving API Results
      • Referenced vs Inline Entities
      • Choosing API Response Data
      • Handling API Errors
    • separator
    • Vehicle Routing Endpoints
      • Path
    • Optimization Endpoints
      • Instantiate
      • Build
      • Assignment Restrictions
      • Optimize
      • Sequence
      • Evaluate
      • Recommend
      • Insert
      • Centroids
      • Zones
      • Consolidate By Job Restrictions
      • Consolidate By Route Assignments
    • Geocoding Endpoints
      • Geocode
      • Reverse Geocode
    • Task Endpoints
      • List
      • Status
      • Result
      • Cancel
    • Sandbox Endpoints
      • List
      • Create
      • Rename
      • Retrieve
      • Update
      • Delete
      • Revisions
      • Add Revision
      • Expiry
      • Permissions
    • Verizon Connect Fleet Integration Endpoints
      • Pull Platform Data
      • Sync Platform Data
      • List Platform Territories
    • Other Endpoints
      • Canonicalize
      • Route Cards
      • Validate
      • Version
    • separator
    • Request Types
      • problem
      • capacity_metric
      • depot
      • driver
      • driver_break
      • job
      • job_template
      • job_type
      • load_amount
      • marker
      • problem_defaults
      • route
      • schedule
      • settings
      • shift
      • shift_override
      • shift_pattern
      • shift_pattern_assignment
      • stop
      • vehicle
      • zone
      • variance
    • Response Types
      • instantiate_response
      • problem_response
      • problem_aggregates
      • driver_response
      • geocoded_location
      • recommend_option
      • route_response
      • schedule_response
      • schedule_instantiate_response
      • stop_response
      • violation
    • Meta Types
      • task_redirect_response
      • task_status_response
      • validate_response
    • Sandbox Types
      • delta
      • array_delta
      • dict_delta
      • keyed_array_delta
      • object_delta
      • set_delta
      • revision
      • revision_created_response
      • revision_response
      • sandbox_response
    • Common Types
      • date_range
      • day_of_week
      • hazmat_load_type
      • id
      • latlon
      • stop_type
      • time_window
      • custom
      • polygon
    • Primitive Types
      • boolean
      • date
      • datetime
      • float
      • integer
      • string
      • timespan

    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

    • The problem.shift_overrides field.
    • The driver.shift_overrides field.
    • The instantiate endpoint.