Differences

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

Link to this comparison view

Both sides previous revision Previous revision
api [2013/06/25 15:43]
jluopajarvi
api [2013/11/08 16:03] (current)
jluopajarvi
Line 1: Line 1:
 ====== API ====== ====== API ======
-The goal is to create a REST API for TestLogger. Both web and mobile clients would use the API. Also it would allow people to create their own clients.Twitter API (https://​dev.twitter.com/​docs/​api/​1.1) is used as an example +The goal is to create a REST API for TestLogger. Both web and mobile clients would use the API. Also it would allow people to create their own clients.
- +
-Currently the TestLogger API is located at http://​testlogger.info/​api/​ +
- +
-===== Specification ===== +
- +
-==== Runs ==== +
-^Resource ​        ​^Description ^ +
-|GET runs/:​id ​    |Gets all data related to specified run. It will also provide a link to laptimes if recorded. | +
-|POST runs/delete |Destroys the run specified by the required ID parameter. The authenticating user must be the author of the specified run.| +
-|POST runs/add |Adds new run to the database. Authenticated user will be assigned as run author. Available parameters +
-|POST runs/update |Update existing run.| +
- +
-==== Sessions ==== +
-^Resource ​        ​^Description ^ +
-|GET sessions/:​id |Get session details and links to related runs| +
-|GET sessions/​public |Get all public sessions| +
-||| +
- +
-==== Friends ==== +
-^Resource ​        ​^Description ^ +
- +
-==== Account ==== +
-^Resource ​        ​^Description ^ +
-|POST account |Fetch all account settings. | +
-|POST account |?| +
- +
-==== Base data ==== +
-^Resource ​        ​^Description ^ +
-|GET basedata/​setups |Get setups. | +
-|GET basedata/​setups/​public |Get public setups. |+