Routing API v7 Developer's Guide

Calculate Isoline

Use the calculateisoline resource to request a polyline that connects the end points of all routes leaving from one defined center with either a specified length or a specified travel time. The required parameters for this resource are an apiKey or app_id and app_code if you are using the app_id/app_code authentication (for the available authentication options, see the Identity & Access Management Developer Guide), start or destination, range, rangetype and mode (specifying how to calculate the route, and for what mode of transport). Other parameters can be left unspecified.

../routing/7.2/calculateisoline.{format}?<parameter>=<value>... 
Parameter Description
apiKey A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged in user, you can generate it at https://here-tech.skawa.fun/projects. API Keys never expire but you can invalidate your API Keys at any time. You cannot have more than two API Keys for one app at the same time.

You must include an apiKey with every request. For more information on authentication, see the Identity & Access Management Developer Guide.

app_id

A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application.

If you use the app ID/app code option, you need to include an app_id and app_code with every request. For more information on authentication, see the Identity & Access Management Developer Guide.

app_code

A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application.

If you use the app ID/app code option, you need to include an app_id and app_code with every request. For more information on authentication, see the Identity & Access Management Developer Guide.

requestId Clients may pass in an arbitrary string to trace request processing through the system. The RequestId is mirrored in the MetaInfo element of the response structure.
start Center of the isoline request. Isoline will cover all roads which can be reached from this point within given range. It cannot be used in combination with destination parameter. WaypointParameterType.
start=geo!52.5,13.4
destination Center of the isoline request. Isoline will cover all roads from which this point can be reached within given range. It cannot be used in combination with start parameter. WaypointParameterType.
destination=geo!52.5,13.4
range

Range of isoline. Several comma separated values can be specified. The unit is defined by parameter rangetype

range=1000
range=1000,2000,3000
rangeType

Specifies type of range. Possible values are distance, time, consumption. For distance the unit is meters. For time the unit is seconds. For consumption it is defined by consumption model

rangetype=distance
rangetype=time
rangetype=consumption
mode

The routing mode determines how the route is calculated.

See also RoutingModeType

Types supported in isoline request: fastest, shortest.

TransportModes supported in isoline request: car, truck (only with type fastest), pedestrian.

Type;TransportModes;TrafficMode;Feature

&mode=fastest;car;traffic:disabled;motorway:-3
departure Time when travel is expected to start. Traffic speed and incidents are taken into account when calculating the route, where applicable. You can use now to specify the current time. It can be used only if parameter start is also used. Type: xs:dateTime.
departure=2013-07-04T17:00:00+02
When the optional timezone offset is not specified time is assumed to be local.
arrival Time when travel is expected to end. Traffic speed and incidents are taken into account when calculating the route, where applicable.. Type: xs:dateTime. It can be used only if parameter destination is also used.
arrival=2013-07-04T17:00:00+02
When the optional timezone offset is not specified time is assumed to be local.
singleComponent

If set to true the isoline service will always return single polygon, instead of creating a separate polygon for each ferry separated island. Default value is false.

singlecomponent=true
resolution

Allows to specify level of detail needed for the isoline polygon. Unit is meters per pixel. Higher resolution may cause increased response time from the service.

resolution=10
maxPoints

Allows to limit amount of points in the returned isoline. If isoline consists of multiple components, sum of points from all components is considered. Each component will have at least 2 points, so it is possible that more points than maxpoints value will be returned. This is in case when 2 * number of components is higher than maxpoints. Enlarging number of maxpoints may cause increased response time from the service.

maxpoints=100
quality

Allows to reduce the quality of the isoline in favor of the response time. Allowed values are 1, 2, 3. Default value is 1 and it is the best quality.

quality=2
jsonAttributes Flag to control JSON output. Combine parameters by adding their values. See also JSON Representation.
jsonattributes=9
jsonCallback

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

truckType

Truck routing only, specifies the vehicle type. Defaults to truck.

Enum [truck | tractorTruck]

Note: Relevant for restrictions that apply exclusively to tractors with semi-trailers (observed in North America). Such restrictions are taken into account only in case of the truckType set to tractorTruck and the trailers count greater than 0 (for example &truckType=tractorTruck&trailersCount=1). The truck type is irrelevant in case of restrictions common for all types of trucks.
trailersCount

Truck routing only, specifies number of trailers pulled by the vehicle. The provided value must be between 0 and 4. Defaults to 0.

shippedHazardousGoods

Truck routing only, list of hazardous materials in the vehicle. Please refer to the enumeration type HazardousGoodTypeType for available values. Note the value allhazardousGoods does not apply to the request parameter.

Enum [explosive | gas | flammable | combustible | organic | poison | radioActive | corrosive | poisonousInhalation | harmfulToWater | other]

limitedWeight

Truck routing only, vehicle weight including trailers and shipped goods, in tons. The provided value must be between 0 and 1000.

weightPerAxle

Truck routing only, vehicle weight per axle in tons. The provided value must be between 0 and 1000.

height

Truck routing only, vehicle height in meters. The provided value must be between 0 and 50.

width

Truck routing only, vehicle width in meters. The provided value must be between 0 and 50.

length

Truck routing only, vehicle length in meters. The provided value must be between 0 and 300.

tunnelCategory

Truck routing only, specifies the tunnel category to restrict certain route links. The route will pass only through tunnels of a less strict category.

Enum [ B | C | D | E ]

tunnelcategory=C
consumptionModel

If you request information on consumption, you must provide a consumption model. The possible values are default and standard. When you specify the value standard, you must provide additional information in the query parameter customconsumptiondetails

consumptionmodel=default
consumptionmodel=standard
customConsumptionDetails

Provides vehicle specific information for use in the consumption model. This information can include such things as the amount of energy consumed while travelling at a given speed. For details on the consumption model see Standard consumption model.

speedProfile

Specifies the speed profile variant for a given routing mode. The speed profile affects travel time estimation as well as roads evaluation when computing the fastest route. Note that computed routes might differ depending on a used profile. See SpeedProfileType for details.

Enum [ default | fast ]

speedProfile=fast
Note: Currently, truck routing is the only mode that supports the speedProfile parameter.