GuidesAPI Reference
Guides

How to read a pickup response

HERE Waypoints Sequence API v8 has the following basic pickup response structure:

  • A waypoints object that lists the optimized waypoint sequence based on the parameters in the request. The value in the element sequence indicates the optimal order. Waypoints that are sub-optimal and would add to the travel time or distance without making it up in profit made by passenger/goods transport are ignored.
  • Information about the total distance and time of your journey.
  • An interconnections object that includes information about the journey between the indicated waypoints.
  • Information about the kind of optimization and supporting information.
  • Meta-information about the request.

Example response:

{
	"results": [
		{
			"waypoints": [
				{
					"id": "waypoint0",
					"lat": 50.11562,
					"lng": 8.63121,
					"sequence": 0,
					"estimatedArrival": null,
					"estimatedDeparture": "2017-09-06T14:49:09Z",
					"fulfilledConstraints": []
				},
				{
					"id": "waypoint1",
					"lat": 50.12254,
					"lng": 8.63107,
					"sequence": 1,
					"estimatedArrival": "2017-09-06T14:52:09Z",
					"estimatedDeparture": "2017-09-06T14:52:09Z",
					"fulfilledConstraints": [ "pickup:LOAD2,value:200,load:0 (destination0 -> destination1)" ]
				},
				{
					"id": "waypoint2",
					"lat": 50.12892,
					"lng": 8.62983,
					"sequence": 2,
					"estimatedArrival": "2017-09-06T14:53:39Z",
					"estimatedDeparture": "2017-09-06T14:53:39Z",
					"fulfilledConstraints": [	"drop:LOAD2,value:200,load:0 (destination0 -> destination1)" ]
				},
				{
					"id": "waypoint3",
					"lat": 50.13254,
					"lng": 8.64928,
					"sequence": 3,
					"estimatedArrival": "2017-09-06T14:57:23Z",
					"estimatedDeparture": null,
					"fulfilledConstraints": []
				}
			],
			"distance": "6055",
			"time": "494",
			"interconnections": [
				{
					"fromWaypoint": "waypoint0",
					"toWaypoint": "waypoint1",
					"distance": 1707.0,
					"time": 180.0,
					"rest": 0.0,
					"waiting": 0.0
				},
				{
					"fromWaypoint": "waypoint1",
					"toWaypoint": "waypoint2",
					"distance": 930.0,
					"time": 90.0,
					"rest": 0.0,
					"waiting": 0.0
				},
				{
					"fromWaypoint": "waypoint2",
					"toWaypoint": "waypoint3",
					"distance": 3418.0,
					"time": 224.0,
					"rest": 0.0,
					"waiting": 0.0
				}
			],
			"description": "Targeted best solution: optimal; without traffic",
			"timeBreakdown": {
				"driving": 494,
				"service": 0,
				"rest": 0,
				"waiting": 0
			}
		}
	],
	"errors": [],
	"processingTimeDesc": "107ms",
	"responseCode": "200",
	"warnings": null,
	"requestId": null
}