X-Git-Url: http://git.maemo.org/git/?p=speedfreak;a=blobdiff_plain;f=documents%2FAPI.txt;h=60067a966c4f8e2cc27445d3af5532e549eb2ee7;hp=e29585dcc16986d050a8f30bb03814a2a9759470;hb=0874c73937c0df94961f9174a49f9f318890f2f3;hpb=8e2751b9dddac3dfb08e3016bc4efcd73404ffe8

diff --git a/documents/API.txt b/documents/API.txt
index e29585d..60067a9 100644
--- a/documents/API.txt
+++ b/documents/API.txt
@@ -79,13 +79,16 @@ In any other case it will return 401 HTTP error code along with error descriptio
 Fetching results
 ================
 
-URL: /results/category_name/limit
+URL: /results/category_name/limit/show_unit
 
 Category: For example "acceleration-0-100", "top-speed" and so on
 Limit: This will tell server how many results you want to get back. Results are
 ordered by record position starting with highest record first.
 
-Both parameters are required.
+category_name and limit are required parameters while show_unit is optional. show_unit can have
+only one value which is true (string). When show_unit is specified every result will have a unit
+attribute where by default it's km/h. Results can have up to two decimals. Dot is used as
+decimal separator.
 
 Below is example of what client might get back in return when sending following
 request: /results/acceleration-0-100/10
@@ -93,11 +96,11 @@ request: /results/acceleration-0-100/10
 <?xml version="1.0" encoding="utf-8"?>
 <results category="acceleration-0-100" unit="seconds" description="Acceleration from 0 to 100 km/h">
     <result position="1" user="test928" date="12/1/2010" value="13" />
-    <result position="2" user="test922" date="15/1/2010" value="12" />
-    <result position="3" user="test92a" date="11/1/2010" value="11" />
+    <result position="2" user="test922" date="15/1/2010" value="12.22" />
+    <result position="3" user="test92a" date="11/1/2010" value="11.12" />
     <result position="4" user="test92s" date="15/2/2010" value="10" />
     <result position="5" user="test92d" date="1/1/2010" value="9" />
-    <result position="6" user="test92f" date="31/1/2010" value="8" />
+    <result position="6" user="test92f" date="31/1/2010" value="8.32" />
     <result position="7" user="test92f" date="1/1/2010" value="7" />
     <result position="8" user="test92g" date="2/1/2010" value="6" />
     <result position="9" user="test92w" date="3/1/2010" value="5" />
@@ -119,6 +122,22 @@ category that result belongs to. Below is example of XML:
 <result value="14" unit="seconds" date="14/2/2010" />
 
 
+Sending route
+=============
+
+URL:
+
+Below is example of XML:
+
+<?xml version="1.0" encoding="UTF-8"?>
+<Route Start-time="19.04.2010 21:44:49" Stop-time="19.04.2010 22:05:44" Points="4">
+	<Point Latitude="65.0024" Longitude="25.4804" Altitude="32" Speed="29.052"/>
+	<Point Latitude="65.0023" Longitude="25.5508" Altitude="45" Speed="29.052"/>
+	<Point Latitude="65.0022" Longitude="25.5509" Altitude="41.5" Speed="29.052"/>
+	<Point Latitude="65.0022" Longitude="25.551" Altitude="37.5" Speed="29.052"/>
+</Route>
+
+
 Logout
 ======