Routing API Developer's Guide

ManeuverType

A maneuver describes the action needed to leave one street segment and enter the following street segment to progress along the route. This type is an abstract base class for PrivateTransportManeuverType and PublicTransportManeuverType . It includes only attributes that are common for any given maneuver type.

Note: In this element, the Length, Shape, and Note refer to the leg immediately following the maneuver.
Figure 1. ManeuverType Diagram of ManeuverType.

ManeuverType defines the following attributes:

Attribute Description
id ElementReferenceType

Key that identifies this element uniquely within the response.

ManeuverType defines the following data elements:

Element Description
Position GeoCoordinateType

Position where the maneuver starts.

Instruction xs:string

Description of the required maneuver, for example, "Turn left onto Minna St." Response format for this description can be either text or HTML as selected in InstructionFormatType , and using the measurement system specified in the request, either metric or imperial. The units for imperial system are based on language specified in request. It will be feet for en-US and yards for en-UK.

For an automated unit conversion, we recommend using MetricSystem=metric, which returns values in kilometers and meters instead of yards and miles.

TravelTime common:DurationType

Describes the amount of time in seconds for a single maneuver, traffic considered if this has been enabled.

See also: TrafficMode .

Length DistanceType

Length (in meters) for the leg between this maneuver and the next.

Shape GeoPolylineType

Shape of the leg between this maneuver and the next.

FirstPoint xs:int

Index into the global geometry array, pointing to the first point of the shape subsegment associated with this Maneuver. Must be followed by LastPoint.

LastPoint xs:int

Index into the global geometry array, pointing to the last point of the shape subsegment associated with this Maneuver. Must be preceded by FirstPoint.

Time xs:dateTime

Estimated point in time when the maneuver should occur, based on the selected transport mode. Options include:

  • Public transport: time at which the user is expected to begin this maneuver, see Public Transport Routing for information on how to compute the departure time of the line.
  • Private transport: calculated departure time for the maneuver.

In both cases the time is given in the timezone of the maneuver's starting position. See also Public Transport Routing for information on differences between time handling in each routing mode.

Note RouteNoteType

Additional information about the route segment following the maneuver, such as "sharp curve ahead", "accessing toll road", etc.

NextManeuver ElementReferenceType

Reference to the next maneuver on the recommended route.

ToLink LinkIdType

The key of the next outgoing link.

BoundingBox GeoBoundingBoxType

Coordinates defining the bounding box of the entire maneuver.

ShapeQuality ShapeQualityType

Shape quality between current maneuver and the next one. Shape quality may vary depending on the transport mode chosen.