How a response looks like

Response

Here you will find information regarding the output which will be created from the router of Roadee.net.

For any question that is not answered here please send an email to developer@roadee.net .

First of all, the output format depends on the output option "web" or "navi". See the "Request" page on how to set the output option.
So we distinguish between these two outputs and below you see a simple comparsion between the two.

Web

Example Route

Navi

Example Route

stacks_image_759EE2D6-D22F-4A2D-9B6D-0D70BF93B666

stacks_image_8886827B-0B99-4D1F-8827-5AC413F9CB9B

Web

As you can see the Web output is pretty much the same as most of the routers available create. It gives route descriptions exactly on that place where the action has to be done. This is good for all of your developers creating websites and want to give the user the ability to create routes on the website. Also for developers of mobile apps, who wants to simple give route dircetions as a cool feature. It will probably not fit all the needs of a developer creating a Turn-by-Turn application.

Navi

The navi output is exactly what you are looking for when it comes to Turn-by-Turn applications. The router creates announcments for the upcoming event. This is a real cool feature! What you get as a response is a full featured Turn-by-Turn route description.

The output formats

The output Web and Navi has a slight but important difference. In the Navi output you will find much more events (route descriptions) but these events have a flag which gives you the information wether this event is an announcment or a real action. Real actions take place where the action is located in real, means the real junction. Announcements are taking place at the exact distance given by the announcement ahaed of the action event. It is up to you how to process the information later on. In the Web interface all events are action events.

JSON

The JSON output is the preffered output format to take since it has every data in a small file. See the JSON Spec to learn how to use JSON Files or find the right precreated JSON interface for your programming language. The contents of the JSON File are pretty simple explained:

{
"source":"Roadeeno Beta 1.0 ",
"license":"http://www.roadee.net/license",
"route_geometry":[
[52.510680,13.386950],
[52.510190,13.387393],
[52.510008,13.384664],
[52.509975,13.384235],
[52.509831,13.381908],
[52.509682,13.379547],
[52.509638,13.378593],
[52.509627,13.378406],
[52.509623,13.378205],
[52.509623,13.377787],
[52.509618,13.377429],
[52.509585,13.376772],
[52.510089,13.376690],
[52.510413,13.376765],
[52.510772,13.376848],
[52.511874,13.377079]
],
"route_summary":{
"total_distance":1034,
"total_time":394,
"start_point":"Mauerstraße",
"end_point":"Ebertstraße"
},
"route_instructions": [
[1,52.510680,13.386950,"Head Southeast on Mauerstraße",62,0,27,"SE","C",0.0],
[1,52.510190,13.387393,"Turn right in Leipziger Straße (B 1)",717,1,265,"W","TR",113.0],
[1,52.509585,13.376772,"Turn right in Potsdamer Platz",132,11,52,"N","TR",89.0],
[1,52.510772,13.376848,"Continue on Ebertstraße",123,14,50,"N","C",-1.0],
[1,52.511874,13.377079,"You have reached your destination",0,0,0,"","DST",0.0]
]
}

As you can see it is all pretty simple despite the last part "route_intructions", but let's go step by step through the output.

First you find some metadata.

"source":"Roadeeno Beta 1.0 ",
"license":"http://www.roadee.net/license"

Then we have the route_geometry. Here the route is written as list of coordinates, which can be easylie connected to a path to show the route in a Panel or on a Map.

"route_geometry":[
[52.510680,13.386950],
[52.510190,13.387393],
[52.510008,13.384664],
[52.509975,13.384235],
[52.509831,13.381908],
[52.509682,13.379547],
[52.509638,13.378593],
[52.509627,13.378406],
[52.509623,13.378205],
[52.509623,13.377787],
[52.509618,13.377429],
[52.509585,13.376772],
[52.510089,13.376690],
[52.510413,13.376765],
[52.510772,13.376848],
[52.511874,13.377079]
]

Next is the route_summary, giving an overview of the whole route.

"route_summary":{
"total_distance":1034,
"total_time":394,
"start_point":"Mauerstraße",
"end_point":"Ebertstraße"
}

And finally the route_intructions. Here you find the infromation of what the user has to do on what point of the route.
Each instruction comes as an array of values. The array and the fileds of the array hold values in the following order:

1. Flag Action "1" or Announcment "2"
2. The latitude on which the instruction takes place.
3. The longitude on which the instruction takes place.
4. The description of the intruction.
5. The distance in meter from the current point of intruction to the next point of intruction.
6. The field number in the route_geometry where the current instruction is located. ( counting starts at 0 )
7. The estimated time in seconds from the current instruction point to the next intruction point.
8. The heading as a string.
9. The code for the Turn information. Possible values:
- TR = Turn Right
- TSLR = Turn Slight Right
- TSHR = Turn Sharp Right
- TL = Turn Left
- TSLL = Turn Slight Left
- TSHL = Turn Sharp Left
- C = Continue
- TU = U-Turn
10. The turn angle.
When going straight on the angle is 0.
When turning exact left the angle is -90.0.
When turning exact right the angle is 90.0.

"route_instructions": [
[1,52.510680,13.386950,"Head Southeast on Mauerstraße",62,0,27,"SE","C",0.0],
[1,52.510190,13.387393,"Turn right in Leipziger Straße (B 1)",717,1,265,"W","TR",113.0],
[1,52.509585,13.376772,"Turn right in Potsdamer Platz",132,11,52,"N","TR",89.0],
[1,52.510772,13.376848,"Continue on Ebertstraße",123,14,50,"N","C",-1.0],
[1,52.511874,13.377079,"You have reached your destination",0,0,0,"","DST",0.0]
]

GPXCOMPLETE

The GPXComplete output is a XML- like output holding all information of the route using the following structure.

<?xml version="1.0" encoding="UTF-8"?>
<gpx creator="roadee.net" version="1.0" xmlns="http://www.topografix.com/GPX/1/1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.topografix.com/GPX/1/1 gpx.xsd ">
    <metadata>
        <author>
            <name>Roadeeno Beta 1.0 </name>
            <email id="info" domain="roadee.net"></email>
            <link href="Roadeeno Beta 1.0 "></link>
        </author>
        <copyright author="aemade">
            <license>http://www.roadee.net/license</license>
        </copyright>
        <time>2010-02-02T15:18:39+0000</time>
    </metadata>
    <wpt lat="52.510680" lon="13.386950"/>
    <wpt lat="52.510190" lon="13.387393"/>
    <wpt lat="52.510008" lon="13.384664"/>
    <wpt lat="52.509975" lon="13.384235"/>
    <wpt lat="52.509831" lon="13.381908"/>
    <wpt lat="52.509682" lon="13.379547"/>
    <wpt lat="52.509638" lon="13.378593"/>
    <wpt lat="52.509627" lon="13.378406"/>
    <wpt lat="52.509623" lon="13.378205"/>
    <wpt lat="52.509623" lon="13.377787"/>
    <wpt lat="52.509618" lon="13.377429"/>
    <wpt lat="52.509585" lon="13.376772"/>
    <wpt lat="52.510089" lon="13.376690"/>
    <wpt lat="52.510413" lon="13.376765"/>
    <wpt lat="52.510772" lon="13.376848"/>
    <wpt lat="52.511874" lon="13.377079"/>
    <extensions>
        <distance>1034</distance>
        <time>394</time>
        <start>Mauerstraße</start>
        <end>Ebertstraße</end>
    </extensions>
    <rte>
        <rtept lat="52.510680" lon="13.386950">
                <desc>Head Southeast on Mauerstraße</desc>
                <type>action</type>
                <number>0</number>
                <extensions>
                    <distance>62</distance>
                    <time>27</time>
                    <offset>0</offset>
                    <direction>SE</direction>
                    <turn>C</turn>
                    <turn-angle>0.0</turn-angle>
                </extensions>
        </rtept>
        <rtept lat="52.510190" lon="13.387393">
                <desc>Turn right in Leipziger Straße (B 1)</desc>
                <type>action</type>
                <number>1</number>
                <extensions>
                    <distance>717</distance>
                    <time>265</time>
                    <offset>1</offset>
                    <direction>W</direction>
                    <turn>TR</turn>
                    <turn-angle>113.0</turn-angle>
                </extensions>
        </rtept>
        <rtept lat="52.509585" lon="13.376772">
                <desc>Turn right in Potsdamer Platz</desc>
                <type>action</type>
                <number>2</number>
                <extensions>
                    <distance>132</distance>
                    <time>52</time>
                    <offset>11</offset>
                    <direction>N</direction>
                    <turn>TR</turn>
                    <turn-angle>89.0</turn-angle>
                </extensions>
        </rtept>
        <rtept lat="52.510772" lon="13.376848">
                <desc>Continue on Ebertstraße</desc>
                <type>action</type>
                <number>3</number>
                <extensions>
                    <distance>123</distance>
                    <time>50</time>
                    <offset>14</offset>
                    <direction>N</direction>
                    <turn>C</turn>
                    <turn-angle>-1.0</turn-angle>
                </extensions>
        </rtept>
        <rtept lat="52.511874" lon="13.377079">
                <desc>You have reached your destination</desc>
                <type>action</type>
                <extensions>
                    <turn>DST</turn>
                </extensions>
        </rtept>
    </rte>
</gpx>

First you find some metadata.

    <metadata>
        <author>
            <name>Roadeeno Beta 1.0 </name>
            <email id="info" domain="roadee.net"></email>
            <link href="Roadeeno Beta 1.0 "></link>
        </author>
        <copyright author="aemade">
            <license>http://www.roadee.net/license</license>
        </copyright>
        <time>2010-02-02T15:18:39+0000</time>
    </metadata>

Then we have the waypoints. Here the route is written as list of coordinates, which can be easylie connected to a path to show the route in a Panel or on a Map.

Next is the route summary enclosed in the extensions tag, giving an overview of the whole route.

    <extensions>
        <distance>1034</distance>
        <time>394</time>
        <start>Mauerstraße</start>
        <end>Ebertstraße</end>
    </extensions>

And finally the route instructions. Here you find the infromation of what the user has to do on what point of the route.
Each instruction comes enclosed in on rtept tag.

The tags of each rtept in detail:
<rtept lat=123456 lon=123456> = Starts the rtept and already shows the coordinate on which this rtept is located.
<desc>The description</desc> = The description of the instruction.
<type>action</type> = Flag Action or Announcement.
<number>0</number> = The number of the rtept.
<distance>62</distance> = The distance in meter from the current point of intruction to the next point of intruction.
<time>27</time> = The estimated time in seconds from the current instruction point to the next intruction point.
<offset>0</offset> = The field number in the waypoints where the current instruction is located. ( counting starts at 0 )
<direction>SE</direction> = The heading as a string.
<turn>C</turn> = The code for the Turn information. Possible values:
- TR = Turn Right
- TSLR = Turn Slight Right
- TSHR = Turn Sharp Right
- TL = Turn Left
- TSLL = Turn Slight Left
- TSHL = Turn Sharp Left
- C = Continue
- TU = U-Turn
<turn-angle>0.0</turn-angle> = The turn angle.
When going straight on the angle is 0.
When turning exact left the angle is -90.0.
When turning exact right the angle is 90.0.

    <rte>
        <rtept lat="52.510680" lon="13.386950">
                <desc>Head Southeast on Mauerstraße</desc>
                <type>action</type>
                <number>0</number>
                <extensions>
                    <distance>62</distance>
                    <time>27</time>
                    <offset>0</offset>
                    <direction>SE</direction>
                    <turn>C</turn>
                    <turn-angle>0.0</turn-angle>
                </extensions>
        </rtept>
        <rtept lat="52.510190" lon="13.387393">
                <desc>Turn right in Leipziger Straße (B 1)</desc>
                <type>action</type>
                <number>1</number>
                <extensions>
                    <distance>717</distance>
                    <time>265</time>
                    <offset>1</offset>
                    <direction>W</direction>
                    <turn>TR</turn>
                    <turn-angle>113.0</turn-angle>
                </extensions>
        </rtept>
        <rtept lat="52.509585" lon="13.376772">
                <desc>Turn right in Potsdamer Platz</desc>
                <type>action</type>
                <number>2</number>
                <extensions>
                    <distance>132</distance>
                    <time>52</time>
                    <offset>11</offset>
                    <direction>N</direction>
                    <turn>TR</turn>
                    <turn-angle>89.0</turn-angle>
                </extensions>
        </rtept>
        <rtept lat="52.510772" lon="13.376848">
                <desc>Continue on Ebertstraße</desc>
                <type>action</type>
                <number>3</number>
                <extensions>
                    <distance>123</distance>
                    <time>50</time>
                    <offset>14</offset>
                    <direction>N</direction>
                    <turn>C</turn>
                    <turn-angle>-1.0</turn-angle>
                </extensions>
        </rtept>
        <rtept lat="52.511874" lon="13.377079">
                <desc>You have reached your destination</desc>
                <type>action</type>
                <extensions>
                    <turn>DST</turn>
                </extensions>
        </rtept>
    </rte>

GPXTRACKFILE

The GPXTrackfile output is a XML- like output holding the route as trackpoints without the route instructions.

<?xml version="1.0" encoding="UTF-8"?>
<gpx version="1.1" creator="Routino" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.topografix.com/GPX/1/1" xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd">
<metadata>
<desc><![CDATA[Shortest route between 'start' and 'finish' waypoints]]></desc>
<copyright author="Roadeeno Beta 1.0 ">
<license>http://www.roadee.net/license</license>
</copyright>
</metadata>
<trk>
<trkseg>
<trkpt lat="52.510680" lon="13.386950"/>
<trkpt lat="52.510190" lon="13.387393"/>
<trkpt lat="52.510008" lon="13.384664"/>
<trkpt lat="52.509975" lon="13.384235"/>
<trkpt lat="52.509831" lon="13.381908"/>
<trkpt lat="52.509682" lon="13.379547"/>
<trkpt lat="52.509638" lon="13.378593"/>
<trkpt lat="52.509627" lon="13.378406"/>
<trkpt lat="52.509623" lon="13.378205"/>
<trkpt lat="52.509623" lon="13.377787"/>
<trkpt lat="52.509618" lon="13.377429"/>
<trkpt lat="52.509585" lon="13.376772"/>
<trkpt lat="52.510089" lon="13.376690"/>
<trkpt lat="52.510413" lon="13.376765"/>
<trkpt lat="52.510772" lon="13.376848"/>
<trkpt lat="52.511874" lon="13.377079"/>
</trkseg>
</trk>
</gpx>

First you find some metadata.

<metadata>
<desc><![CDATA[Shortest route between 'start' and 'finish' waypoints]]></desc>
<copyright author="Roadeeno Beta 1.0 ">
<license>http://www.roadee.net/license</license>
</copyright>
</metadata>

Then we have the waypoints. Here the route is written as list of coordinates, which can be easylie connected to a path to show the route in a Panel or on a Map.

GPXROUTEFILE

The GPXRouteFile output is a XML- like output holding only the route instructions.

<?xml version="1.0" encoding="UTF-8"?>
<gpx version="1.1" creator="Routino" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.topografix.com/GPX/1/1" xsi:schemaLocation="http://www.topografix.com/GPX/1/1 http://www.topografix.com/GPX/1/1/gpx.xsd">
<metadata>
<desc><![CDATA[Shortest route between 'start' and 'finish' waypoints]]></desc>
<copyright author="Roadeeno Beta 1.0 ">
<license>http://www.roadee.net/license</license>
</copyright>
</metadata>
<rte>
<name>Shortest route</name>
<rtept lat="52.510680" lon="13.386950"><name>Head Southeast on Mauerstraße</name></rtept>
<rtept lat="52.510190" lon="13.387393"><name>Turn right in Leipziger Straße (B 1)</name></rtept>
<rtept lat="52.509585" lon="13.376772"><name>Turn right in Potsdamer Platz</name></rtept>
<rtept lat="52.510772" lon="13.376848"><name>Continue on Ebertstraße</name></rtept>
<rtept lat="52.511874" lon="13.377079"><name>You have reached your destination</name></rtept>
</rte>
</gpx>

First you find some metadata.

<metadata>
<desc><![CDATA[Shortest route between 'start' and 'finish' waypoints]]></desc>
<copyright author="Roadeeno Beta 1.0 ">
<license>http://www.roadee.net/license</license>
</copyright>
</metadata>

Then we have the route instructions with the coordinates describing where the event takes place.

<rte>
<name>Shortest route</name>
<rtept lat="52.510680" lon="13.386950"><name>Head Southeast on Mauerstraße</name></rtept>
<rtept lat="52.510190" lon="13.387393"><name>Turn right in Leipziger Straße (B 1)</name></rtept>
<rtept lat="52.509585" lon="13.376772"><name>Turn right in Potsdamer Platz</name></rtept>
<rtept lat="52.510772" lon="13.376848"><name>Continue on Ebertstraße</name></rtept>
<rtept lat="52.511874" lon="13.377079"><name>You have reached your destination</name></rtept>
</rte>

Roadee.net developer section

Find everything you need to use roadee.net for your idea.