Web services listing
Web service documentation  -  Distances and Directions  -  Optimisation/FreeDirections/v2.00

DistancesAndDirections/Optimisation/FreeDirections (v 2.00)

Returns the directions between two or more points. This version of the Directions service does not consume credits. However, the input must be an ID that is returned by the Optimise web service, which would have consumed credits.

SOAP WSDL

Standard HTTP
http://services.postcodeanywhere.co.uk/DistancesAndDirections
/optimisation/FreeDirections/v2.00/wsdlnew.ws

Secure HTTPS
https://services.postcodeanywhere.co.uk/DistancesAndDirections
/optimisation/FreeDirections/v2.00/wsdlnew.ws

REST code samples & end points

We have sample code available for most development environments. Choose a language below and click the button to view the code.

View

We're more than just a SOAP service. Select an end point below and click the button to view an example.

View

Try it

Enter your values in the form below to try the service for yourself.

Name Value Type Description Default Example
FreeRouteID String The encrypted ID returned by the Optimise method.   089034107220220142108030155089186090210074029015005067114102057053190249205223243071041161013090177239119069147128031166096059128157186038106093210100209247065052197247136165174086110161112081255175093139095096165246022212135078151254061034137191184029177247071108125036182087138141146101
   

* 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
FreeRouteID String The encrypted ID returned by the Optimise method.     08903410722022014210
80301550891860902100
74029015005067114102
05705319024920522324
30710411610130901772
39119069147128031166
09605912815718603810
60932101002092470650
52197247136165174086
11016111208125517509
31390950961652460222
12135078151254061034
13719118402917724707
11081250361820871381
41146101

* 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
SegmentNumber Integer A zero based counter indicating the row number.   0
StepNumber Integer A zero based counter indicating the row number.   0
Action String The type of routing instruction.   D
Description String Textual description of the routing instruction.   Depart WEST from start on [Moseley Road]
Road String The name of the road to turn onto.   [Moseley Road]
StepTime Integer The time in seconds for this part of the route. (This parameter should be disregarded in favour of the timings output from the Optimise method, if that is where you obtained the FreeRouteID from; these timings here will not include delivery pause times, reloads and so on, nor do they include Speed Profiles data.)   226
StepDistance Integer The distance in metres for this part of the route.   3363
TotalTime Integer The total time in seconds for the route. (This parameter should be disregarded in favour of the timings output from the Optimise method, if that is where you obtained the FreeRouteID from; these timings here will not include delivery pause times, reloads and so on, nor do they include Speed Profiles data.)   226
TotalDistance Integer The total distance in metres for the route.   3363

Prices

This table will outline the costs (in credits) or required licenses for this web service. Many web services support both credits or licenses while many are free!

Option Cost Notes
Credit Pack: Standard Free!  

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 FreeRouteID No the ID entered was invalid. Please ensure the ID you provide was the exact one output by the Optimise method.

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 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 the key is correct, it should be the in 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 that looks fine, please contact support as it may be from an IP addresses 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 that looks fine, please contact support as it may be from a URL on our black list.
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 if the usage seems normal. Check the usage details first though to see if it is unexpected.
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 and 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 it is recommended management keys are use with care. Log onto 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 or, if you would like the limit increased, please contact us.
14 Free service limit exceeded You have used too many free web services. Many of our web services are designed to operate in several 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 try 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 have recently renewed your key. Please contact us if your have any questions.