Hivepath API (1.0.0)

Download OpenAPI specification:Download

Documentation for the Hivepath route optimisation API. We currently have a single endpoint /optimisation that allows you to request an optimised solution for a given list of vehicles and jobs.

Authorisation is performed as a header parameter apiKey using the api key requested from us
The optional geometry query parameter allows requests to toggle on/off fetching additional geometry data. Turning this off will improve response times
All response durations are in seconds
All response distances are in meters

Route optimisation endpoint

Authorizations:

ApiKeyAuth

query Parameters

geometry

boolean

Default: true

Request Body schema: application/json

	Array of objects (OptimisationRequestVehicle)
	Array of objects (OptimisationRequestJob)

Responses

Request samples

Payload

Content type

application/json

{"vehicles": [{"id": "string",
"startTime": "10:25",
"endTime": "10:25",
"maxJobs": 0,
"postcode": "string",
"breaks": [ ],
"skills": [ ]
}
],
"jobs": [{"id": "string",
"startTime": "10:25",
"endTime": "10:25",
"postcode": "string",
"jobLength": 0,
"skill": "string"
}
]
}

Response samples

Content type

application/json

{"routes": [{"vehicleId": "string",
"distance": 0.1,
"duration": 0,
"waitingTime": 0,
"service": 0,
"steps": [{"arrival": "10:25",
"distance": 0.1,
"duration": 0,
"jobId": "string",
"location": {"geoLocation": {"long": 0.1195,
"lat": 51.5032
},
"postcode": "string"
},
"type": "END"
}
],
"geometry": "string"
}
],
"statusCode": "INPUT_ERROR",
"statusMessage": "string",
"unassigned": [{"id": "string",
"type": "VEHICLE",
"location": {"geoLocation": {"long": 0.1195,
"lat": 51.5032
},
"postcode": "string"
},
"fixedJobs": [{"id": "string",
"startTime": "10:25",
"endTime": "10:25",
"postcode": "string"
}
]
}
]
}