DistancesAndDirections/Optimisation/GetResults (v 1.00)
Retrieve the full results of the route optimisation job.
REST code samples & end points
Choose a code sample language below.
Select an end point to view an example.
Try it
Enter your values in the form below to try the service for yourself. We've put some example values in already to get you started.
* Optional - if left blank the default is used.
Parameters
Each request to the web service requires a number of parameters, all of which are listed below. All requests require a key which was generated when you registered. You can create any number of keys, each of which can be reported on individually and have specific security settings.
| Name |
Type |
Description |
Default |
Values |
Example |
|
Key |
String |
The key to use to authenticate to the service. |
|
|
AA11-AA11-AA11-AA11 |
|
JobID |
Integer |
The ID of the route optimisation job you wish to get results for. |
|
|
5 |
* Optional - if left blank the default is used.
Fields
The response from the web service is a table with the specification below. Where no items are found, the response will be empty (although all endpoints specify the columns). If an error occurs, the response will not follow this format. Instead the response will be an error table (see general and specific errors).
| Name |
Type |
Description |
Values |
Example |
|
VehicleNumber |
Integer |
A zero based counter indicating the vehicle number. |
|
0 |
|
VehicleID |
String |
The ID of the vehicle, if it was supplied in the input. |
|
VanOne |
|
StepType |
String |
An enumeration representing the type of step on the route. |
Start | Finish | Delivery | Travel | Depot | Wait | Break | ExcludedWaypoint |
Start |
|
StepNumber |
Integer |
A zero based counter indicating the step number in this vehicle's journey. |
|
0 |
|
WaypointID |
String |
The ID of the waypoint, if it was supplied in the input. |
|
VanOne |
|
Location |
String |
The location string. These will be the same as the location strings which were input. |
|
WR26NJ |
|
CumulativeTime |
Float |
The time at which we start this step. E.g. if the StepType is Travel, this is the time at which we set out on the journey; if the StepType is Delivery, this is the time we arrive at the delivery location. Measured in minutes from the vehicle start time. |
|
0 |
|
CumulativeDistance |
Integer |
The cumulative distance for the route so far, in metres. When StepType is Travel, this is the distance to the start of that particular journey step - e.g. the very first Travel step will have a cumulative distance of 0. |
|
0 |
|
TotalTime |
Float |
The total time in minutes for this vehicles route, including stops. |
|
123.117 |
|
TotalDistance |
Integer |
The total distance in metres for this vehicles route. |
|
111682 |
|
AverageTime |
Float |
The average time in minutes for all vehicles routes, including stops. |
|
133.967 |
|
AverageDistance |
Integer |
The average distance in metres for all vehicles routes. |
|
153712 |
|
MaximumTime |
Float |
The maximum time in minutes of a vehicles route, including stops. |
|
144.817 |
|
MaximumDistance |
Integer |
The maximum distance in metres of a vehicles route. |
|
195741 |
Prices
This table will outline the credit costs or required licenses for this web service. Many web services support both credit or licenses while many are free!
| |
£25
Plan |
£50
Plan |
£100
Plan |
£250
Plan |
£500
Plan |
£1,000
Plan |
£2,500
Plan |
| There is no associated charge for look-ups using this web service. |
Response Errors
Below are the errors which are specific to this web service (more general errors are listed below). If an error occurs, an error table like the one below will be returned (developers should test for a 4 column table with columns "Error", "Description", "Cause" and "Resolution". An error response will only contain a single row.
| Error |
Description |
Cause |
Resolution |
|
1001 |
Invalid JobID |
No job with that ID was found on your account, or the JobID was not entered. |
Please enter a valid JobID, as returned by the "Create" web service, that is no more than three months old. |
|
1002 |
Job not started |
You cannot get the results of the job if it has not yet been optimised. |
Please call StartOptimisation to trigger the optimisation process. |
|
1003 |
Job not complete |
You cannot get the results of the job if it has not yet finished optimising. |
Please wait until the result of GetStatus indicates that the job has completed. |
|
1004 |
Job has errors |
You cannot get the results of the job if it has completed with errors. |
Please call GetStatus to retrieve the error details. |
|
1005 |
Too many GetResults checks |
You called GetResults too many times in quick succession. |
Please wait at least 5 seconds between successive GetResults calls. |
General Errors
These errors are general service errors and may be returned by any web service. Note that general errors are all below 100 while service specific errors start at 1000.
| Error |
Description |
Cause |
Resolution |
|
-1 |
Unknown error |
The cause of the error is unknown but details have been passed to our support staff who will investigate. |
These problems are typically short lived and are often resolved by trying again in a few minutes. |
|
2 |
Unknown key |
The key you are using to access the service was not found. |
Please check that the key is correct. It should be in the form AA11-AA11-AA11-AA11. |
|
3 |
Account out of credit |
Your account is either out of credit or has insufficient credit to service this request. |
Please check your account balance and top it up if necessary. |
|
4 |
Request not allowed from this IP |
The request was disallowed from the IP address. |
Check the security settings on the key first. If they look fine, please contact support as it may be from an IP address on our blacklist. |
|
5 |
Request not allowed from this URL |
The request was disallowed from the URL. |
Check the security settings on the key first. If they look fine, please contact support as it may be from a URL on our blacklist. |
|
6 |
Web service not available on this key |
The requested web service is disallowed on this key. |
Check the security settings on the key first. You can limit a key to certain web services. |
|
7 |
Web service not available on your plan |
The requested web service is not currently available on your payment plan. |
Some services are only available in specific regions due to licensing restrictions. Please contact us for more information. |
|
8 |
Key daily limit exceeded |
The daily limit on the key has been exceeded. |
Alter the daily limit on the key. Check the usage details first to see if usage is normal. |
|
9 |
Surge protector running |
The surge protector is currently enabled and has temporarily suspended access to the account. |
You can disable the surge protector at any time, but this is only recommended if you are running through a batch of requests. |
|
10 |
Surge protector triggered |
An unusually large number of requests have been processed for your account so the surge protector has been enabled. |
You can disable the surge protector at any time but this is only recommended if you are running through a batch of requests. |
|
11 |
No valid license available |
The request requires a valid license but none were found. |
Please check your purchase history. You may be using a license that is no longer valid or of an incorrect type. |
|
12 |
Management key required |
To use this web service you require a management key. Management can be enabled on any key, but we advise you to use management keys with care. |
Sign in to the website and create a new management key or change an existing key. |
|
13 |
Demo limit exceeded |
The daily demonstration limit for this service or account has been exceeded. |
The limit will be reset at midnight tonight. If you would like the limit increased, please contact us. |
|
14 |
Free service limit exceeded |
You have used too many free web services. |
Our web services are designed to operate in stages. The first is usually a Find service followed by a Retrieve. If you use too many Finds without the corresponding number of Retrieves you will receive this error. For more information, please contact us. |
|
15 |
Wrong type of key |
The type of key you're using isn't supported by this web service. |
This usually happens if you're using a user or server license with a web service that only supports transactional keys. Please use another key and try again. |
|
16 |
Key expired |
The key you are trying to use has expired. |
Please check that you are using the right key. A new one may have been issued if you recently renewed your key. Contact us if you have any questions. |