Using the route optimisation API
Provided as part of the distances and directions API, our optimise service can be run for single or multiple vehicles and supports timeslots, capacities, pause times, vehicle dimensions and speed profile data.
| Web Service |
Description |
DistancesAndDirections Optimisation Create
v1.00 |
Creates a new route optimisation job and returns the JobID.
|
DistancesAndDirections Optimisation GetCost
v1.00 |
Retrieve an upper-bound cost estimate for the optimisation job, in credits or number of vehicle licenses used. Note that the actual cost will be lower than this if, for any reason, one or more waypoints are not successfully routed to. If the job has already completed successfully, this service will return the actual amount that was used.
|
DistancesAndDirections Optimisation GetDirections
v1.00 |
Returns the turn by turn directions for any or all vehicles for a completed route optimisation job.
|
DistancesAndDirections Optimisation GetResults
v1.00 |
Retrieve the full results of the route optimisation job.
|
DistancesAndDirections Optimisation GetStatus
v1.00 |
Retrieve the status of the existing route optimisation job, including any error messages.
|
DistancesAndDirections Optimisation StartOptimisation
v1.00 |
Tell the route optimisation engine that you wish to start the optimisation process running.
|
DistancesAndDirections Optimisation UpdateJob
v1.00 |
Add or edit settings for the existing route optimisation job.
|
DistancesAndDirections Optimisation UpdateVehicles
v1.00 |
Add, edit or remove a vehicle from the existing route optimisation job. You may update several vehicles at once by passing in arrays of values; these arrays must be of equal length.
|
DistancesAndDirections Optimisation UpdateWaypoints
v1.00 |
Add, edit or remove a waypoint from the existing route optimisation job. You may update several waypoints at once by passing in arrays of values; these arrays must be of equal length.
|
DistancesAndDirections Optimisation VerifyLocation
v1.00 |
Determines whether or not each entry in a batch of postcodes, OS coordinates or latitude / longitude coordinates maps to the road network of the UK, Europe, USA or Canada. This free service can be used to pre-validate postcodes and location strings before passing into any of the Distances and Directions web services, and should always be used before calling the Optimise method.
|