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 parameters supported have the same meaning as those of the Routing API.

Resource URI

GET /2/calculateroute.json
  ?app_id={YOUR_APP_ID}
  &app_code={YOUR_APP_CODE}
  &overlays=MY_OVERLAY_MAP
  &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 contain the OVERLAY string.

mode mandatory

string

fastest;car;traffic:disabled or fastest;car;traffic:disabled.

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.

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.

storage mandatory

string

Currently, only readonly is supported.

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.

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.