FindSequence
Use the resource findsequence
to get a good order of waypoints.
.../2/findsequence.json?<parameter1>=<value1>&<parameter2>=<value2>&...
When using POST
, Content-Type
must be application/x-www-form-urlencoded
and all parameters in the body, except for apiKey
. If you use the app ID/app code option, except for app_id
and app_code
.
Required Parameters
Parameter | Type | Description |
---|---|---|
app_id | String | Typically, but not guaranteed to be, 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 further details, see the Identity & Access Management Developer Guide. |
app_code | String | Typically, but not guaranteed to be, 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 further details, see the Identity & Access Management Developer Guide. . |
apiKey | String | 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://developer.here.com/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 further details, see the Identity & Access Management Developer Guide. |
departure | DateTimeString | Time when travel is expected to start. Traffic speed and incidents are taken into account when calculating the route. departure is required, if trafficmode:enabled is set or if properties are added to waypoints. The format is as xsd type xs:datetime For Example: 2014-11-11T16:52:00+2b02:00 , 2014-11-11T16:52:00Z |
destinationN | Waypoint with ID; lat,lon; constraints... (see WaypointWithIdType) | Intermediate destinations, at least one. If no end parameter is provided, one of these values is selected as end of the sequence. Waypoints of destination parameters can have appointment or access hour constraints. The maximum number of waypoints including the start point and end point is 120 without traffic and 50 with traffic. If the routing mode The waypoint id can be followed by a semicolon separated list of constraints. Supported constraints:
If any if these constraints is used, a |
mode | String | The routing mode specifies how the route is to be calculated. The parameter must be specified on the following pattern: In this pattern:
tollRoads , motorways or boatFerrys . Please see the description of the RoutingModeType in HERE Routing API for details. Please note that route weightings are separated by commas, e.g. ...traffic:disabled;tunnel:-2,motorway=-1 The parameter |
start | Waypoint with ID | Starting Position of the Journey. For Example: start=52.2,8.1 |
Optional Parameters
Parameter | Type | Description |
---|---|---|
avoidLinks | List of Link Ids | Links that the route may not cross. |
avoidArea | List of Bounding Boxes | Areas which the route must not cross. |
end | Waypoint with ID | Optional Position to be reached at the end of the journey. This value can be omitted. In this case the journey will end at any of the destinations. |
hasTrailer | Boolean | The value indicates if a truck has a trailer. |
height | Number | Defines the height of the truck in meters (0 - 10) |
improveFor | String | Defines the result parameter to be optimized:
time . |
jsonCallback | String | Specifies the name of a user-defined function used to wrap the JSON response (JSONP). If a JSON callback is set, the http response status is always "200 OK". In the case of an error |
length | Number | Defines the length of the truck in meter (0 - 100) |
limitedWeight | Number | Defines vehicle weight including trailers and shipped goods, in tons (0 - 200) |
requestId | Text | Clients may pass in an arbitrary string to trace request processing through the system. The requestId is mirrored in the response of the service. |
restTimes | Driving and Rest Specification Type | Specification of driving and rest times |
shippedHazardousGoods | List of Strings | List of hazardous goods. For Example: |
tunnelCategory | Number | Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E. |
walkSpeed | Number | Defines the walking speed for pedestrian mode. Default is HLP Router's default walk speed. Allowed values are 0.5 ... 2 meters per second. |
weightPerAxle | Number | Defines the vehicle's weight per axle in tons (0 - 200) |
width | Number | Defines the width of the truck in meters (0 - 10) |
Hazardous Goods
FindSequence requests can include the following hazardous goods:- explosive
- Explosive material
- gas
- Gas
- flammable
- Flammable material
- combustible
- Combustible material
- organic
- Organic material
- poison
- Poison
- radioActive
- Radio-active material
- corrosive
- Corrosive material
- poisonousInhalation
- Materials that are poisonous upon inhalation
- harmfulToWater
- Materials that are harmful to water
- other
- Other types of hazardous materials
Please see HERE Routing API for a comprehensive list of supported values.