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
  ?app_id={YOUR_APP_ID}
  &app_code={YOUR_APP_CODE}
  &overlays=OVERLAYMYMAP
  &mode=...
  &waypoint0=..., &waypoint1=..., ...
  &departure=...
  &storage=readonly

For more information, see Constructing a Request.

Resource Parameters

Parameter Description
overlays optional

string

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

mode mandatory

string

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 semantice are the same like HLS Router.

waypoint0 ... waypointN mandatory

string

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

string

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

string

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

string

Currently, only readonly is supported.

language optional

string

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

string

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

string

Truck measures specification parameters. They have the same values and semantics like for HLS Router. In addition, they can have the unit specifications cm, in, m, kg, lbs and t.

jsonAttributes optional

number

Only 41 is supported. Default is 41. Note that for HLS Router the default is not 41!

callback ooptional

String

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.