Request
Here you will quickly find the answer to the question: How can I request a route?
For any question that is not answered here please send an email to developer@roadee.net .
First of all an example:
Here you will quickly find the answer to the question: How can I request a route?
For any question that is not answered here please send an email to developer@roadee.net .
First of all an example:
The above URL is a simple example to show you how a request to Roadee.net has to look like. So let's go into more detail by splitting up the entire URL into pieces. Make sure when creating a request URL set the "/" as delimiter between all parts as shown above.
To try out the router and all below given options go here.
Part of the URL
Meaning
http://map.roadee.net/roadee_net_api/index.php/api/param/
This is the main URL to the Roadee.net API.
YOUR-API-KEY
This is your API-Key. If you don't already have created a Key then just go here. In each request you have to set your API-Key. This is the way we are able to show you the statistics for your account.
web
Here you can decide which output you want to have.
Possible Parameter:
- web
- navi
Possible Parameter:
- web
- navi
en
Here you can select the language of the output.
Possible Parameter:
- en
- de
You can easylie create additional languages. Just have a look here.
Possible Parameter:
- en
- de
You can easylie create additional languages. Just have a look here.
gpxcomplete
Here you can select the output format of the response to your request
Possible Parameter:
Possible Parameter:
- js
This is the famous JSON output format.
- gpxcomplete
This is the whole route within one GPX Document.
- gpxtrack
That will give you all track poinst of the route.
- gpxroute
That will give you only the route and the events.
- text
That will give you summary like text document of the calculated route
- textall
That will give all information of the route in one text document.
shortest
Here you can choose the route type.
Possible Parameter:
- shortest
- quickest
Possible Parameter:
- shortest
- quickest
motorcar
Here you can choose from one of the following vehicles.
Possible Parameter:
- foot
- horse
- wheelchair
- bicycle
- moped
- motorbike
- motorcar
- goods
- hgv
- psv
Possible Parameter:
- foot
- horse
- wheelchair
- bicycle
- moped
- motorbike
- motorcar
- goods
- hgv
- psv
1
Here you can choose wether the router should obay oneway or not
Possible Parameter:
- 1
- 0
Possible Parameter:
- 1
- 0
9.94050:49.80325:9.92603:49.80099
Here you set the start coordinates, optionally intermediate point coordinates as well as the end coordinates for the route.
Possible Parameter:
You can set up to 99 coordinates. The router will take the first coordinate as the start and the last coordinate as the end. All coordinates in between are taken as intermediate points.
Make sure that the coordinates are all delimited with the ":" and come as "longitude:latitude".
Possible Parameter:
You can set up to 99 coordinates. The router will take the first coordinate as the start and the last coordinate as the end. All coordinates in between are taken as intermediate points.
Make sure that the coordinates are all delimited with the ":" and come as "longitude:latitude".
100-100-90-80-70-60-50-80-0-0-0-0
Here you can set the highway preferences for the given route. The types of roads are delimited with the "-" and are in the following order. All values are percents from 0 - 100 percent.
Order of road types:
1. motorway
2. trunk
3. primary
4. secondary
5. tertiary
6. unclassified
7. residential
8. service
9. track
10. cycleway
11. path
12. steps
Order of road types:
1. motorway
2. trunk
3. primary
4. secondary
5. tertiary
6. unclassified
7. residential
8. service
9. track
10. cycleway
11. path
12. steps
112-96-96-88-80-64-48-32-16-0-0-0
Here you can set the speed limits or the speed used by the user on the particular road type.
The speeds for the respective roade types are delimited with "-". Range for the value is 0 - 999.
Order of road types:
1. motorway
2. trunk
3. primary
4. secondary
5. tertiary
6. unclassified
7. residential
8. service
9. track
10. cycleway
11. path
12. steps
The speeds for the respective roade types are delimited with "-". Range for the value is 0 - 999.
Order of road types:
1. motorway
2. trunk
3. primary
4. secondary
5. tertiary
6. unclassified
7. residential
8. service
9. track
10. cycleway
11. path
12. steps
100-75-50-50
Here you can set the usage of special roads with giving a percent value. All values are percents from 0 - 100.
Order of special road:
1. paved
2. multilane
3. bridge
4. tunnel
Order of special road:
1. paved
2. multilane
3. bridge
4. tunnel
0-0-0-0
Here you can set specifications for the used vehicle. This leads to total different routes for let's say Trucks compared to a common motorcar.
Vehicle specs in order:
1. length
2. height
3. width
4. weight
Vehicle specs in order:
1. length
2. height
3. width
4. weight