• 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_pattern_assignment

    A shift_pattern_assignment represents the assignment of a single shift_pattern to a driver for a given date range. It determines the base date from which the shift pattern's shifts begin, as well as optionally defining an end date for the pattern.

    Name Type Description
    end_date date The date of the final day that this shift pattern will be in effect for the driver. This is useful if different shift patterns are required for different periods of time. If not provided, the shift pattern will be in effect indefinitely.
    shift_pattern shift_pattern or id Required. The shift pattern to be assigned to the driver for this date range.
    start_date date Required. The date of the first day that this shift pattern will take effect for the driver. The shift pattern will begin with its first day's shifts on this date.

    Example

    {
      "shift_pattern": {
        "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" }],
          []
        ]
      },
      "start_date": "2017-01-01"
    }
    

    See Also

    • The shift_pattern type.
    • The driver.shift_patterns field.
    • The instantiate endpoint.