CalculateRoutesRequest

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Features that are allowed while calculating a route.

Link copied to clipboard

Time of arrival at the destination.

Link copied to clipboard

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

Link copied to clipboard

Uses the current time as the time of departure.

Link copied to clipboard

Time of departure from thr origin.

Link copied to clipboard

The final position for the route. In the World Geodetic System (WGS 84) format: [longitude, latitude].

Link copied to clipboard

Destination related options.

Link copied to clipboard

Driver related options.

Link copied to clipboard

Features to be strictly excluded while calculating the route.

Link copied to clipboard

Measurement system to be used for instructions within steps in the response.

Link copied to clipboard
val key: String?

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Link copied to clipboard

List of languages for instructions within steps in the response.

Link copied to clipboard

A list of optional additional parameters such as timezone that can be requested for each result.

Link copied to clipboard

Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

Link copied to clipboard

Maximum number of alternative routes to be provided in the response, if available.

Link copied to clipboard

Specifies the optimization criteria for calculating a route.

Link copied to clipboard

The start position for the route.

Link copied to clipboard

Origin related options.

Link copied to clipboard

A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

Link copied to clipboard

Toll related options.

Link copied to clipboard

Traffic related options.

Link copied to clipboard

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Link copied to clipboard

Travel mode related options for the provided travel mode.

Link copied to clipboard

Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.

Link copied to clipboard

List of waypoints between the Origin and Destination.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String