• 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

    List of Primitive Types

    boolean

    The JSON boolean type.

    Valid values:

    • true
    • false

    date

    A date, represented in ISO 8601 format.

    Examples:

    • "2010-09-13"
    • "2016-01-23"
    • "2020-03-07"

    datetime

    A date and time, represented in ISO 8601 format.

    Example:

    • "2016-01-23T10:07:06"

    float

    A floating point number, represented by the JSON float type.

    Examples:

    • 123
    • 12.34567
    • -456.789

    integer

    An integer number, represented by the JSON number type.

    Examples:

    • 123
    • 42
    • 0
    • -27

    string

    A sequence of characters, represented by the JSON string type.

    Examples:

    • ""
    • "Hello world"
    • "This is a string"

    timespan

    A timespan represents a time interval, and can be positive or negative. It is a JSON string of the format:

    "[-][d.]hh:mm[:ss[.ff]]"
    

    with the elements

    • d - days.
    • hh - hours.
    • mm - minutes.
    • ss - seconds.
    • ff - fractional seconds up to three decimal places.

    Note that some time intervals represent a "time of day", meaning they are taken from midnight.

    Examples:

    • 4 hours, 30 minutes: "04:30"
    • 1 hour, 5 minutes, 10 seconds: "01:05:10"
    • 30.5 seconds: "00:00:30.5"
    • 1 day, 3 hours: "1.03:00" or "27:00"