Differences

This shows you the differences between two versions of the page.

--- icecondor:api [2008/09/14 20:02] – 192.168.0.3
+++ icecondor:api [2024/01/31 04:08] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 === web/SVG version ===
-http://donpark.org/icecondor/doc/post.svg \\
+http://donpark.org/icecondor/doc/post.svg (currently out of date) \\
-http://donpark.org/icecondor/doc/search.svg
+http://donpark.org/icecondor/doc/search.svg (currently out of date)
 === Introduction ===
@@ Line 8: / Line 8: @@
 success/error reporting: HTTP response code \\
-id = Any unique string identifier (usually a URL) \\
+=== IDs/URIs ===
-lat = signed float (in degrees) \\
-long = signed float (in degrees) \\
+the id field in icecondor is a URI, with some standard URNs defined.
-alt = signed float (in meters) \\
-time = 2008-09-05T22:00Z (ISO8601) \\
+A person is generally defined by their OpenID URL.
-hdop = float (Dilution of Precision) \\
+<code>
-vdop = float \\
+http://openid_server/username
-pdop = float \\
+</code>
-radius = float (in meters) \\
+If there is no identified URL for the user, a regular uuid can be generated.
+<code>
+urn:uuid:7a13feb0-829d-11dd-ad8b-0800200c9a66
+</code>
+The follow URNs are used to build an icecondor id when the MAC address of a wifi access point or a bluetooth device are known.
+<code>
+urn:wifi:00:11:22:33:44:55
+urn:bluetooth:00:11:22:33:44:55
+</code>
 === Update location ===
@@ Line 23: / Line 35: @@
 POST /locations
 input:
-  id=<id> lat=<x> long=<y> alt=<z> time=<w> HDOP=<hdop> VDOP=<vdop> PDOP=<pdop>
+  client[version]="YYYYMMDD"
+  location[timestamp]=<2008-09-05T22:00+0000 (ISO8601)>
+  location[guid]=<openid url>
+  location[latitude]=<float>
+  location[longitude]=<float>
+  location[altitude]=<altitude in meters>
+  location[accuracy]=<horizontal accuracy in meters>
+  location[velocity]=<speed in meters/s>
+  location[heading]=<direction in degrees>
   or
-  id=<id> next_to=<other id> radius=<in meters>
+  location[guid]=<openid url> location[next_to]=<other guid> location[radius]=<in meters> (unimplemented)
 output:
+</code>
 === Search ===
-GET /locations/<guid>
+<code>
+GET /locations?id=<guid>
 input:
   search filters:
-  radius=<radius> - return the last record for any ids in the radius
+    radius=<radius> - return the last record for any ids in the radius
-   lat=<lat>
+    lat=<lat> - center the search on this lat/long
-   long=<long>
+    long=<long>
-   alt=<alt> (optional)
+    alt=<alt> (optional)
+   or
+    id=<id> - center the search on the last location for this id
+    limit=<count>
 output:
   returns the most recent post.
-  [id,lat,long,alt,time,hdop,vdop,pdop]
+  [id,lat,long,alt,time,radius]
 </code>
-=== GUIDs ===