Routing API v7 Developer's Guide

RoutingModeType

The RoutingMode specifies how the route is calculated. Parameter representation:

RoutingMode = Type + [TransportModes] + [TrafficMode] + [Feature]

Parameter component	Structure
Type	RoutingType relevant to calculation. See also RoutingTypeType. Enum [ `fastest` \| `shortest` \| `balanced` ];
[TransportModes]	Specify which mode of transport to calculate the route for. See alsoTransportModeType. Enum [`car` \| `pedestrian` \| `carHOV` \| `truck` \| `bicycle`
[TrafficMode]	Specify whether to optimize a route for traffic. See also TrafficModeType. traffic: Enum [`enabled` \| `disabled` \| `default`]
[Feature]	Route feature weightings to be applied when calculating the route. As many as required. See also RouteFeatureType and RouteFeatureWeightType. RouteFeatureType: RouteFeatureWeightType `motorway:-2;`

&mode=fastest;car;traffic:disabled;motorway:-2

RoutingTypeType

RoutingType provides identifiers for different optimizations which can be applied during the route calculation. Selecting the routing type affects which constraints, speed attributes and weights are taken into account during route calculation.

Enumeration	Description
`fastest`	Route calculation from start to destination optimized by travel time. Depending on the traffic mode provided by the request, travel time is determined with or without traffic information. In some cases, the route returned by the fastest mode may not be the route with the shortest possible travel time. For example, the routing service may favor a route that remains on a highway, even if a shorter travel time can be achieved by taking a detour or shortcut through a side road.
`shortest`	Route calculation from start to destination disregarding any speed information. In this mode, the distance of the route is minimized, while keeping the route sensible. This includes, for example, penalizing turns. Because of that, the resulting route will not necessarily be the one with minimal distance.
`balanced`	Route calculation from start to destination optimizing based on combination of travel time and distance.

TrafficModeType

Enumeration	Description
`enabled`	No departure time provided: This behavior is deprecated and will return error in the future. Static time based restrictions: Ignored Real-time traffic closures: Valid for entire length of route. Real-time traffic flow events: Speed at calculation time used for entire length of route. Historical and predictive traffic speed: Ignored Departure time provided: Static time based restrictions: Avoided if road would be traversed within validity period of the restriction. Real-time traffic closures: Avoided if road would be traversed within validity period of the incident. Real-time traffic flow events: Speed used if road would be traversed within validity period of the flow event. Historical and predictive traffic: Used.
`disabled`	No departure time provided: Static time based restrictions: Ignored Real-time traffic closures: Ignored. Real-time traffic flow speed: Ignored. Historical and predictive traffic: Ignored Departure time provided: Static time based restrictions: Avoided if road would be traversed within validity period of the restriction. Real-time traffic closures: Valid for entire length of route. Real-time traffic flow speed: Ignored. Historical and predictive traffic: Ignored Note: Difference between traffic disabled and enabled affects only the calculation of the route. Traffic time of the route will still be calculated for all routes using the same rules as for traffic:enabled.
`default`	Let the service automatically apply traffic related constraints that are suitable for the selected routing type, transport mode, and departure time. Also user entitlements will be taken into consideration.

TransportModeType

Depending on the transport mode special constraints, speed attributes and weights are taken into account during route calculation.

Note: When you specify a mode, you can choose from four speed profiles: car, light truck, medium truck, or heavy truck. Speeds used in route calculation depend on the chosen mode. The heavy truck profile is only used if you specify a value for the parameter limitedweight greater than 18 tons. The medium truck profile is only used if you specify a value for the parameter limitedweight greater than 7.5 tons and less than or equal to 18 tons. The light truck profile is only used if you specify a value for the parameter limitedweight less than or equal to 7.5 tons. The car speed profile is used if truck is not specified in the routing mode.

Enumeration	Description
`car`	Route calculation for cars.
`carHOV`	Route calculation for HOV (high-occupancy vehicle) cars.
`pedestrian`	Route calculation for a pedestrian. As one effect, maneuvers will be optimized for walking, that is segments will consider actions relevant for pedestrians and maneuver instructions will contain texts suitable for a walking person. This mode disregards any traffic information.
`truck`	Route calculation for trucks. This mode considers truck limitations on links and uses different speed assumptions when calculating the route.
`bicycle`	Route calculation for bicycles. This mode uses the pedestrian road network, but uses different speeds based on each road's suitability for cycling. Pedestrian roads that are also open for cars in the travel direction are considered open for cycling, as are pedestrian roads located in parks. These roads use full bicycle speed for routing. Other pedestrian roads, including travelling the wrong way down one-way streets, are considered at the pedestrian walking speed, as it is assumed the bicycle must be pushed.

RouteFeatureType

The routing features can be used to define special conditions on the calculated route. The user can weight each feature with non-positive weights, see type RouteFeatureWeightType.

Parameter	Description
`tollroad`	Identifier for toll roads
`motorway`	Identifier for motorways
`boatFerry`	Identifier for boat ferries
`railFerry`	Identifier for rail ferries
`tunnel`	Identifier for tunnels
`dirtRoad`	Identifier for dirt roads
`park`	Identifier for links through parks. This route feature is only applicable for pedestrian and bicycle routing.

RouteFeatureWeightType

Route feature weights are used to define weighted conditions on special route features like tollroad, motorways, etc.

Enumeration	Description
`-3`	`strictExclude` The routing engine guarantees that the route does not contain strictly excluded features. If the condition cannot be fulfilled no route is returned.
`-2`	`softExclude` The routing engine will assign very large penalties to links with the corresponding feature.
`-1`	`avoid` The routing engine assigns penalties for links containing the corresponding feature.
`0`	`normal` The routing engine does not alter the ranking of links containing the corresponding feature.