Deeplink

From RouteXL
Revision as of 15:55, 6 November 2017 by Routexl (talk | contribs) (Optional parameters)
Jump to: navigation, search

Deeplinking is opening the website with addresses. This is the most easy way of connecting your system to our route planner. You add addresses to the URL, which are automatically recognized, imported to the map and optimized.

URL format

To load addresses automatically, add addresses to the URL in this format:

 www.routexl.nl/?q=<address1>$<address2>$<address3>$<address4>

In other words, using the parameter q and seperating with a dollar sign. Addresses need to be urlencoded.

Optional parameters

To change the language of the website, add the parameter lang:

 www.routexl.nl/?q=<address1>$<address2>$<address3>$<address4>&lang=en

By default the deeplink will find a roundtrip. The first address is also the endpoint of the route. To have the route end at the last address, add the parameter roundtrip and set it to false.

 www.routexl.nl/?q=<address1>$<address2>$<address3>$<address4>&roundtrip=false

Additional fields

This is experimental, but you can add additional fields to each address. E.g. name of the stop, its servicetime, time slot and comments. To add these fields, use the same import formatting. Additional fields must be urlencoded with the address.

Example

https://www.routexl.nl/?q=Jan%20Ligthartstraat%201%2C%20Alkmaar%24Markt%2011%2C%20Arnhem%24Martinikerkhof%2012%2C%20Groningen%24Snekertrekweg%201%2C%20Leeuwarden%24Westerbrink%201%2C%20Assen%24Luttenbergstraat%202%2C%20Zwolle%24Visarenddreef%201%2C%20Lelystad%24Pythagoraslaan%20101%2C%20Utrecht%24Houtplein%2033%2C%20Haarlem%24Zuid-Hollandplein%201%2C%20Den%20Haag%24Abdij%206%2C%20Middelburg%24Brabantlaan%201%2C%20Hertogenbosch%24Limburglaan%2010%2C%20Maastricht&lang=en