Home

Important!

Requests will be made to

user:password@http://server.com/index.php/apps/marble/api/v1/action

where action can have the following values:

ROUTES

1. Upload route - **/routes/**create

   1. Request type:** POST** with these data fields:

      1. timestamp: for uniquely identifying the routes

      2. kml: the kml file itself (FILE field)

      3. preview: image file for previewing the route (FILE field)

      4. name: pretty name for the route

      5. distance: route length

      6. duration: estimated route duration

   2. Response: JSON the result of the operation: *success */ failure, see below.

2. Obtain route list - **/**routes - GET

   3. Request type: GET

   4. Response: JSON: an array of dictionaries containing:

      7. timestamp

      8. name

      9. distance

      10. duration

3. Download route - /routes/$TIMESTAMP

   5. Request type: GET

   6. Response: the kml identified by $TIMESTAMP

4. Download route preview - /routes/preview/$TIMESTAMP

   7. Request type: GET

   8. Response: the preview image

5. Delete route - /routes/delete/$TIMESTAMP

   9. Request type: DELETE

   10. Response: the result of the delete operation, see below.

6. Rename route - /routes/rename

   11. Request type: POST with two fields:

       11. timestamp: route’s identifier

       12. newName: the new name of the route identified by $TIMESTAMP

   12. Response: the result of the rename operation, see below.

BOOKMARKS

1. Update KML: **/api/v1/**bookmarks/update

   1. request: POST with fields:

      1. bookmarks - the bookmarks kml (as a FILE, not string!)

   2. response: status report (JSON - status + timestamp of modification )

2. Get KML: /api/v1**/**bookmarks

   3. request: GET

   4. response: the KML (wrapped in JSON)

3. Update JSON: /bookmarks/update

   5. request: POST with fields:

      2. bookmarks - JSON array of bookmarks

   6. response: status report (JSON - status + timestamp of modification)

4. Get JSON: /bookmarks

   7. request: GET

   8. response: a JSON array of bookmarks (wrapped in JSON, see below)

5. Timestamp: /bookmarks/timestamp

   9. request: GET

   10. response: a JSON containing a timestamp field.

6. External API timestamp: **/api/v1/**bookmarks/timestamp

   11. request, response: same as above

Responses will be JSON structured like this:

• "status" : either “success” or “error”

• "data" : data itself, optional in case of error.

• "message" : error message, optional in case of success.