Enumerations

Defines what kind of roads should be avoided while calculating a route. The given road types can still be considered during route planning but the computed routes will only contain them if no other routes exist or if avoiding such roads would result in a large detour. Please use Route Sections to check for violations.

Represents the desired amount of hilliness for a thrilling route. Note: This parameter can only be used in conjunction with routeType=thrilling

This represents the ‘routeType’ parameter in a Request to the Routing API.

Either of avoidVignette or allowVignette.

Used to decide how to optimize the order of waypoints.

Represents the desired amount of turns for thrilling routes Note: This parameter can only be used in conjunction with routeType=thrilling.

Represents the ‘extendedRouteRepresentation’ parameter values in a Request to the Routing API.

Budget for determining maximum range which can be traveled.

Specifies the representation of the set of routes provided as a response.

Represents the ‘alternativeType’ parameter in a Request to the Routing API.

Specifies whether to include announcement points in instructions. Supported only in routing with extended guidance.

Road side on arrival preference for waypoints and destination.

Specifies whether to include extended guidance sections in the response, such as road shield, lane, and speed limit sections.

List of exceptions that can be thrown during the creation of GuidanceOptions.

Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instruction.

When using any value other than none, phonetic information will be returned in the Response as follows:

• Instructions containing a Instruction.street street field are extended with:

  • Instruction.phoneticStreet: Phonetic string in the requested phonetic format.
  • Instruction.phoneticStreetLanguageCode: Language code in which the phonetic string is encoded.

• Instructions containing a [Instruction.signpostText] field are extended with:

  • Instruction.phoneticSignPostText: Phonetic string in the requested phonetic format.
  • Instruction.phoneticSignPostTextLanguageCode: Language code in which the phonetic string is encoded.

• Instructions containing a [Instruction.roadNumbers] array are extended with:

  • Instruction.phoneticRoadNumbers: Array of phonetic strings in the requested phonetic format corresponding to the respective elements of the roadNumbers array.
  • Instruction.phoneticRoadNumberLanguageCodes: Array of language codes in which the respective phonetic strings are encoded.

Represents the ‘instructionsType’ parameter in a Request to the Routing API.

GuidanceVersion defines the Guidance API version to be used.

Specifies whether to include progress points (travel time and distance points) in the response.

Specifies whether to include road shield references into the external road shields atlas. Instructions contain roadShieldReferences

Represents types of sections of the route

RouteInformationMode defines how much guidance information (instructions and lane guidance) is returned with the route from the RoutePlanner.planRoute() function.

Represents routing options error.