Waypoints Sequence Extension API Developer's Guide

Constructing a Request

The basic elements of a request to the Waypoints Sequence Extension API are the start point, a number of destination points and the routing mode.

You can include an end point. If the request does not contain an end point, one of the destination points you provide are chosen. Each point defining the start, a destination or the end consist of WaypointId, latitude and longitude in the WGS 84 system. For more information about the format, see WaypointWithIdType.

Using the parameter improvefor, you can define if to minimize the travel time or travel distance .

mode indicates whether the result is suitable for a car or a truck and whether to use traffic information when processing the request. In addition, mode defines whether single interconnections are fastest or shortest. This setting is important for interaction with the routing APIs. We recommend fastest for most use cases. Be sure to provide a time for the departure if you enable traffic.

For authentication, the parameters app_id and app_code are mandatory. see also Acquiring Credentials.

The table below lists the basic request elements with examples. Additionally, a request may contain more resource-specific parameters, such as parameters for truck specification. For more information about resource-specific parameters, see FindSequence.
Table 1. Basic request elements
Element Value/Example Description
Base URL
https://wse.api.here.com
https://wse.cit.api.here.com

Production environment only.

For the CIT environment base URL, see HERE Server Environments.

Path
 /2/

The path consists of the major service version only.

Resource
findsequence.json

GET only, specify request details via query parameters.

Format of Response
json

The format of the response is JSON. Usage of JSONP is supported.

Application Code
&app_code={YOUR_APP_CODE}

Substitute your own unique app_code.

Application Id
&app_id={YOUR_APP_ID}

Substitute your own unique app_id.

Start Point
&start= WiesbadenCentralStation;50.0715,8.2434
First waypoint.
A Intermediate Destination
&destination1= FranfurtCentralStation;50.1073,8.6647
The first of the waypoints.
Another Intermediate Destination
&destination2= DarmstadtCentralStation;49.8728,8.6326

The maximum number of waypoints including the start point and end point is 120 without traffic and 50 with traffic. If the routing mode pedestrian is used, the distance between each two of the waypoints must not be greater than 5km.

End Point
&end=MainzCentralStation;50.0021,8.259

The route end/destination. This parameter is optional. If it is not provided, the service automatically chooses a point from those provided in the request parameters.

Routing Mode
&mode=fastest;car;traffic:enabled;

Specifies the way interconnection routes are calculated.

Departure
&departure=2014-12-01T17:30:00+01:00

Required if traffic:enabled; is set in the routing mode.

Optimization Target
&improveFor=time

Specifies the target for optimizing the calculation results. This parameter is optional.

Request Id
&requestId=userGenerated85

This ID is echoed in the result to allow for tracking the request through the service. This parameter is optional.