This chapter describes the response structure of the HERE Waypoints Sequence Extension API.
Response of the resource
|errors||List of strings|| This field provides descriptions of errors which occurred during the calculation. The value is always included in the answer, but is a empty array, if there is no error. |
|processingTimeDesc||String||Calculation time for the result, including the time unit. If the response does not contains an error, the processing time value is included.|
|requestId||String||Identifier defined in the request and passed through the system. This field is null, if no such value was defined in the request.|
|responseCode||String||This value is set to the HTTP response code. If the parameter jsonCallback is set in the request, the HTTP response code is always 200. In this case this field gives the actual response code.|
|results||List of results||This List contains 1 or 0 elements with an ordered list of waypoints. This value is set, if a result is found.|
|warnings||List of OutOfSequence Waypoints||This List contains 0 or more elements with an ordered list of waypoints. This value is set only, if no sequence is found due to constraints.|
List of Results details
|description||String||Description how the sequence of waypoints was calculated.|
|distance||Number|| Length of the journey defined by the sequence of waypoints. |
|interconnections||List of times and distances|| For each interconnections between two subsequent waypoints the time and distance are given. The values for an interconnection include the costs for route between two waypoints. The interconnection starts with the departure at a waypoint and ends when the service at the next waypoint begins. This includes possible waiting times at the second waypoint but does not include the service time there. In particular a possible rest during the service time is not booked to an interconnection. Each list entry consists of |
|time||Number|| Time needed for the journey, defined by the sequence of waypoints, depending on the provided parameters this value includes traffic or a static time calculation. |
|timeBreakdown||Object with Numbers|| Detailed information about how the time needed for the journey in spent: |
|waypoints||List of ordered waypoints|| |
The found sequence of waypoints. For each waypoint
If you choose to make a calculation including traffic information or if you set constraints, the field
If a constraint is set for a waypoint, these field contains a list with the fulfilled constraints in the input format.
Details of Warnings
warnings contains issues preventing the successful calculation of a sequence. The only field inside is
outOfSequenceWaypoints which contains a list of waypoints that cannot be reached because of constraints. An entry of
outOfSequenceWaypoints is described in this table.
|id||String||Description how the sequence of waypoints was calculated.|
|lat||Number||The latitude of the waypoint.|
|lng||Number||The longitude of the waypoint.|
List containing pairs of unmet constraints and reasons.