Routing API Developer's Guide

RouteLegType

The service defines a route leg as the portion of a route between one waypoint and the next. RouteLegType contains information about a route leg, such as the time required to traverse it, its shape, start and end point, as well as information about any sublegs contained in the leg due to the presence of passthrough waypoints.

Note: passThrough waypoints do not create explicit route legs, but instead create sublegs. The service provides subleg information within this type if any are present.
Figure 1. RouteLegType This image shows a graphical representation of the Route Leg Type.

RouteLegType defines the following attributes:

Element Description
Start WaypointType

Route waypoint that is located at the start of this route leg. This waypoint matches one of the waypoints in the Route.

End WaypointType

Route waypoint that is located at the end of this route leg. This waypoint matches one of the waypoints in the Route.

Length DistanceType

Length of the leg.

TravelTime common:DurationType

The time in seconds needed to travel along this route leg. Considers any available traffic information, if enabled and the authorized for the user.

Maneuver ManeuverType

List of all maneuvers which are included in this portion of the route.

Link xs:list

List of all links which are included in this portion of the route. See also LinkIdType .

BoundingBox GeoBoundingBoxType

Bounding Box of the leg.

Shape GeoPolylineType

Shape of route leg.

FirstPoint xs:int

Index into the global geometry array, pointing to the first point of the shape subsegment associated with this leg. 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 leg. Must be preceded by FirstPoint.

TrafficTime common:DurationType

Time in seconds required for this route leg, taking available traffic information into account.

BaseTime common:DurationType

Estimated time in seconds spent on this leg, without considering traffic conditions. The service may also account for additional time penalties, therefore this may be greater than the leg length divided by the base speed.

Summary RouteSummaryType

Distance and time summary information for the route leg.

SubLegSummary RouteSummaryType

Distance and time summary information for any sub legs of this route leg. The service defines sub legs where passThrough waypoints are used, so the list may be empty if no such waypoints exist within this route leg.