Custom Route Extension API Developer's Guide

Calculate Route

Calculates a route using map modifications from custom overlay maps.

This resource is built on top of the Routing API, but currently, it only supports a subset of the features. Hence, before replacing a Routing API calculateroute.json / .xml call with this resource, make sure the features or parameters you require are supported. The supported parameters have the same meaning as those of the Routing API.

Custom Route Extension API redirects to HLP Router if no overlay is requested or the overla layer(s) don't exist or are not accessible to the app_id. So in this case, all HLP Router options can be used and the response is like specified for HLP Router.

Resource URI

GET /2/calculateroute.json
  &waypoint0=..., &waypoint1=..., ...

For more information, see Constructing a Request.

Resource Parameters

Parameter Description
overlays optional


Overlay map name. Case insensitive. Must start with OVERLAY and contain only characters.

mode mandatory


fastest;car;traffic:disabled;... or fastest;car;traffic:disabled;.... As optional parameters motorway (0, -1, -2, -3) and tollroad (0, -1, -2, -3) can follow. The values and semantics are the same like the HERE Routing API.

waypoint0 ... waypointN mandatory


Comma separated waypoint latitude, longitude in WGS-84 degree. A route must consist of at least 2 waypoints (start and destination). The maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time. To define a loading/delay time at a waypoint, use stopOver[,timeInSeconds]!. Example: &waypoint1=stopOver,300!50.12,8.65. None of the optional specifications geo!, stopOver!, passThrough!, altitude, transitRadius, custom label, heading, !StreetPosition, !LinkPosition are currently supported.

departure optional


Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. Default: Avoid all time dependent access restrictions. If no timezone is specified, then the local timezone at the route start link is used.

arrival optional


Format like departure. Use this to find out when you have to start the journey to arrive at the given time. Note that toll cost is not considered when arrival time is specified.

storage mandatory


Currently, only readonly is supported.

language optional


Language for the mneuver instructions in the response. Currently de-de, en-us and it-it are supported. If not specified, en-us is used.

avoidLinks optional


Comma separated list of link ids to be avoided. Positive ids are not driven from reference node, negative ids are not driven towards reference node.

height, length, limitedWeight, trailersCount, shippedHazardousGoods, tunnelCategory, weightPerAxle, width optional


Truck measures specification parameters. They have the same values and semantics as the HERE Routing API. In addition, they can have the unit specifications cm, in, m, kg, lbs and t.

ignoreWayPointVehicleRestriction optional


Router will reach way points even if they are forbidden for the vehicle type (like the HERE Routing API). For this vehicle restrictions can be ignored (as necessary) within the specified radius around the way point.

jsonAttributes optional


Currently, only 41 is supported. This is the default value.

Note: This value differs from the HERE Routing API, where it's default is not 41.
callback optional


Specifies the name of a user-defined function used to wrap the JSON response.

Response Format

The response applies to CalculateRouteResponseType of the HERE Routing API with additions and modifications where overlay maps cause route changes.

For more information about CalculateRouteResponseType, see CalculateRouteResponseType.