Routing API Developer's Guide

RouteSummaryType

This type provides summary information for the entire route. This type of information includes travel time, distance, and descriptions of the overall route path.

Figure 1. RouteSummaryType This image shows a graphical representation of the Route Summary Type.

RouteSummaryType elements used in calculate route and get route responses:

Element Description
Distance DistanceType

Indicates total travel distance for the route, in meters.

TrafficTime common:DurationType

Contains the travel time estimate in seconds for this element, considering traffic and transport mode. Based on the TrafficSpeed. The service may also account for additional time penalties, so this may be greater than the element length divided by the TrafficSpeed.

BaseTime common:DurationType

Contains the travel time estimate in seconds for this element, considering transport mode but not traffic conditions. Based on the BaseSpeed. The service may also account for additional time penalties, therefore this may be greater than the element length divided by the BaseSpeed.

Flags RouteLinkFlagType

Special link characteristics (like ferry or motorway usage) which are covered by the route.

TravelTime common:DurationType

Total travel time in seconds optionally considering traffic depending on the request parameters.

Text xs:string

Textual description of route summary.

Co2Emission

Estimation of the carbon dioxyde emmision for the given Route. The value depends on the VehicleType request parameter which specifies the average fuel consumption per 100 km and the type of combustion engine (diesel or gasoline). Unit is kilograms with precision to three decimal places.

RouteSummaryType elements used in calculate matrix responses:

Element Description
Distance DistanceType

Indicates total travel distance for the route, in meters.

TravelTime common:DurationType

Total travel time in seconds optionally considering traffic depending on the request parameters.

CostFactor xs:int

An internal cost used for calculating the route. This value is based on the objective function of the routing engine and related to the distance or time, depending on the request settings (such as pedestrian versus car routes). The value may include certain penalties and represents the overall quality of the route with respect to the input parameters. Computing the CostFactor value is computationally less expensive compared to calculating distance and/or time. Especially for computing matrix routes and 1:n routes this value is preferred over distance or travel time, as it allows computing responses in much less time. CostFactor is also the preferred metric for comparing multiple routes such as for doing trip planning (traveling salesman problem) based on the response of a matrix route calculation. If time and distance is required for only a subset of a matrix route response, it is recommended to query for distance and time seperately, instead of requesting these values directly for a matrix request.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.