RoutingOptions
Represents parameters used in a Routing API Request.
Important: This is a Public Preview API. It may be changed or removed at any time.
Parameters
Itinerary represents the plan of the user for a specific route.
The departure time. Specified in RFC 3339 format with an optional time zone offset. Example:
1996-12-19T16:39:57
1996-12-19T16:39:57-08:00
The type of the requested route. Defaults to RouteType.FAST
Whether the traffic information will be considered. The default value is true.
Something that the route calculation should try to avoid when determining the route.
The mode of travel for the requested route. Defaults to TravelMode.CAR
Degree of hilliness for a thrilling route. Note: This parameter can only be used in conjunction with routeType=RouteType.THRILLING.
Level of turns for thrilling route. Note: This parameter can only be used in conjunction with routeType=RouteType.THRILLING.
The maximum number of route alternatives to be calculated by the service. The default value is 0.
When maxAlternatives is greater than 0, allows to specify the objective of computing alternative routes: finding routes that are significantly different than the reference route, or finding routes that are better than the reference route.
All alternative routes returned will follow the reference route from the origin point of the calculateRoute Request for at least this number of meters. This can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt.
All alternative routes returned will follow the reference route from the origin point of the calculateRoute Request for at least this number of seconds. This can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt.
Specifies an identifier for the request. The value should be unique for each request. The value must match the regular expression '^a-zA-Z0-9-{1,100}$'. If specified, the same value is sent back in the similar-named response header. Otherwise, a generated value may be sent back.
The instruction type for the route calculation.
The language of the guidance messages.
Proper nouns (the names of streets, plazas, etc.) are returned in the specified language, or if that is not available, they are returned in an available language that is close to it.
Allowed values are (a subset of) the IETF language tags described here.
The currently supported languages are listed in the Supported languages section.
Defaults to the currently set device locale.
The route representation for the route calculation.
Specifies whether to include additional info like:
travel time from start of the route
distance from start of the route
This additional data is generated for group of intermediate points on polyline requested in routeRepresentation and represented as list of com.tomtom.sdk.common.route.Route.intermediateRouteSteps.
includeExtendedRouteRepresentation data is available only in routing with extended guidance.
Whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.
The vehicle heading for route calculation.
Which of the section types should be reported in the result.
The desired arrival time for the route calculation. Specified in RFC 3339 format with an optional time zone offset. Example:
1996-12-19T16:39:57
1996-12-19T16:39:57-08:00
A list of base route points per leg to be used as input for route reconstruction.
This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which toll roads with vignettes are allowed. Specifying allowVignettes with some countries X is equivalent to specifying avoidVignettes with all countries but X. Specifying allowVignettes with an empty list is the same as avoiding all toll roads with vignettes. Note: It is an error to specify both avoidVignettes and allowVignettes.
This is a list of 3-character, ISO 3166-1, alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided. Toll roads with vignettes in countries not in the list are unaffected. Note: It is an error to specify both avoidVignettes and allowVignettes.
Areas which will be avoided.
Whether the report should be provided in the RoutingResult.
Parameters for an electric vehicle.
Parameters for a combustion vehicle.
Specifies whether to include announcement points in instructions. If specified, the instruction will include up to three additional fine-grained announcement points, each with its own location, maneuver type, and distance to the instruction point. Available only in routing with extended guidance.
Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instructions in the response. Available only in routing with extended guidance.
Specifies whether to include road shield references into the external road shields atlas. Available only in routing with extended guidance.
Specifies the coordinate precision to use for returned geometry.
Any which can be used to provide additional data to a custom implementation of RoutingApi.