changeset 96:a7c46e8bb988

README: Document GPX endpoint
author Lewin Bormann <lbo@spheniscida.de>
date Tue, 08 Dec 2020 22:09:04 +0100
parents ebc250ea457f
children 397c7e0b406f
files README.md
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Tue Dec 08 22:05:04 2020 +0100
+++ b/README.md	Tue Dec 08 22:09:04 2020 +0100
@@ -92,6 +92,12 @@
   know. GeoHub will only return events newer than this. The IDs used here are
   returned as property `id` in the GeoJSON `Feature`s.
   * Returns a GeoJSON object.
+* `GET` `/geo/<client>/retrieve/gpx?secret=<secret>&from=<from_timestamp>&to=<to_timestamp>&limit=<maximum
+number of entries returned>&last=<id of last known entry>`
+  * Fetch geo data as GPX document (`application/gpx+xml`).
+  * This endpoint has the same parameters as the `retrieve/json` endpoint. It
+  returns a GPX document containing one Track consisting of one Track Segment.
+  The GPX version is 1.0.
 * `GET` `/geo/<client>/retrieve/last?secret=<secret>&last=<last ID>&limit=<max
 entries>`
   * Fetch most recent points for the `client`. See `/geo/<client>/retrieve/json`