Routing API v7 Developer's Guide


A Route describes a distinct path through the navigable road network between two or more waypoints. It consists of route legs, each of which is a path between two waypoints.

Figure 1. RouteType

RouteType defines the following attributes:

Element Description
RouteId xs:string

Permanent unique identifier of the route, generated based on route links. Can be used to reproduce any previously calculated route.

If a RouteId is requested, but fails to be calculated for any reason then the RouteId element is not available in the response. The rest of the route is intact.

Waypoint WaypointType

List of waypoints that have been defined when requesting for a route calculation. The first waypoint is defined as the start of the route; the last waypoint marks the destination. Any points in between the two are considered via points.

Mode RoutingModeType

Settings for route calculation. One mode can be specified for each route.

Shape GeoPolylineType

Shape of the route as a polyline. The accuracy might depend on the resolution specified in mpp (meters per pixel) when requesting the route. In some use cases (like web portals), only the route's shape is required without the nested structure of a route and detailed knowledge of the links and LinkIds. In this case, the shape does not need to be acquired by traversing the route's links, but can be represented using this attribute at route level.

BoundingBox GeoBoundingBoxType

Bounding Box of the route.

Leg RouteLegType

Partition of the route into legs between the different waypoints.

Note RouteNoteType

Notes that are either related to the calculation (violated routing options) or that refer the route as a whole. In addition to these notes additional notes can be attached to maneuvers. The maneuver notes are usually related to the route segment following the maneuver and would be of interest when passing this segment.

Summary RouteSummaryType

Overall route distance and time summary.

SummaryByCountry RouteSummaryByCountryType

Route distance and time summary per traversed country.

Generalizations Enumeration Types

A simplified base polyline with a given tolerance parameter used to reduce the number of points. The points in the base polyline are implicitly referenced by index.

ManueverGroup ManeuverGroupType

Maneuvers organized into sections based on TransportModeType. It provides the user grouped itinerary summary and brief route instructions.

Incident IncidentType

An incident describes a temporary event on a route. It typically refers to a real world incident (accident, road construction, etc.) spanning on one or several subsequent links.

Label xs:string

Unique names within a route used to distinguish between alternative routes. They can be city names, road names or something else that makes the distinction possible.

Zone RoutingZoneType

A list of routing zones crossed by the route.

TimeDependentRestriction TimeDependentRestrictionType

A list of time dependent restrictions on the route except truck specific restrictions. Truck specific restrictions are being provided in TruckRestrictions element of PrivateTransportLinkType. The restrictions in the list are referred by TimeDependentRestrictionRef elements of RouteLinkType . Therefore to enable TimeDependentRestriction data in the response, specify linkattributes=ti when requesting a route.