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 for sequence optimization, you must provide an end point for pickup along route. 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.
| Element | Value/Example | Description |
|---|---|---|
| Base URL | | Production environment only. For the CIT environment base URL, see HERE Server Environments. |
| Path | | The path consists of the major service version only. |
| Resource | | GET only, specify request details via query parameters. |
| Format of Response | | The format of the response is JSON. Usage of JSONP is supported. |
| Application Code | | Substitute your own unique |
| Application Id | | Substitute your own unique |
| Start Point | | First waypoint. |
| A Intermediate Destination | | The first of the waypoints. |
| Another Intermediate Destination | | The maximum number of waypoints including the start point and end point is 120 without traffic and 50 with traffic. If the routing mode |
| End Point | | The route end/destination. This parameter is optional for findsequence. If it is not provided, the service automatically chooses a point from those provided in the request parameters. |
| Routing Mode | | Specifies the way interconnection routes are calculated. |
| Departure | | Required if |
| Optimization Target | | Specifies the target for optimizing the calculation results. This parameter is optional. |
| Request Id | | This ID is echoed in the result to allow for tracking the request through the service. This parameter is optional. |