Appearance

Date/Time Routing ​

Date/Time Routing gives the user the ability to specify the time and date of a route, thus compensating for lanes that are HOV at specific times, timed-turned restrictions, and seasonal or specific day of the week closures.

date ​

  • Type: string
  • Default: Current date

Provide a calendar date MM/DD/YYYY with the specified by localTime parameter. Alternatively, the date can be specified in the ISO 8601 format YYYY-MM-DDThh:mm via the isoLocal parameter.

If timeType is 0 (disables date/time routing) or 1 (uses the current date time), this option will be ignored.

isoLocal ​

  • Type: string
  • Default: Current date and time

The date/time in ISO 8601 format YYYY-MM-DDThh:mm. Alternatively, the date and localTime parameters can be used to specify the date and time separately.

If timeType is 0 or 1, this option will be ignored.

localTime ​

  • Type: string
  • Default: Current time

When used in conjunction with date, this parameter can be used to set a specific time of day to generate a route in hh:mm format.

If timeType is 0 (disables date/time routing) or 1 (uses the current date time), this option will be ignored.

timeType ​

  • Type: integer
  • Default: 0

Specifies the time type to use. Acceptable values are:

  • 0 - None
    No date/time options will be used
  • 1 - Current
    Uses the current date/time when generating a route.
  • 2 - Start At
    May specify a specific date/time or day of the week to use when generating a route.
  • 3 - Arrive By
    May specify a specific date/time or day of the week to use when generating a route.

toleranceAfter ​

  • Type: integer
  • Default: 0

Sets the minutes after the specified arrive time to allow. Values need to be entered in mm format.

If timeType is 0, 1, or 2, this option will be ignored. If timeType is 3, this is an optional parameter.

toleranceBefore ​

  • Type: integer
  • Default: 15

Sets the minutes before the specified arrive time to allow. Values need to be entered in mm format.

If timeType is 0, 1, or 2, this option will be ignored. If timeType is 3, this is an optional parameter.

useTraffic ​

  • Type: boolean
  • Default: false

If set to true, will use historical and real-time traffic speeds (depending on route time and availability of data) to influence the route. If this option is set to true, the timeType option must be set to something other than 0 (None).

walkingSpeed ​

  • Type: double
  • Default: 2.5

This is the speed (in miles per hour as default and it does adhere to the unit specifier) allowed for the pedestrian routeType. This is used for computing expected route times for walking routes.