-
Notifications
You must be signed in to change notification settings - Fork 3
/
api.raml
848 lines (848 loc) · 37.1 KB
/
api.raml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
#%RAML 1.0
---
title: OpenWorkout
baseUri: http://openworkout.cloud/api/{version}
mediaType: application/json
version: v1
types:
UUID:
type: string
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
export_format_type:
type: string
pattern: ('csv'|'gpx'|'tcx')
/update_status:
description: Used by the mobile application to update it's status.
post:
queryParameters:
DeviceId: UUID
ActivityId: UUID
responses:
200: Empty string
500: An internal exception was thrown.
/activity_track:
description: Returns the activity track as a collection of JSON objects.
get:
queryParameters:
activity_id: UUID
num_points: number
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
401: Failed authentication. The session token was expired, invalid, or not provided.
500: An internal exception was thrown.
/activity_metadata:
description: Returns the activity metadata as a collection of JSON objects.
get:
queryParameters:
activity_id: UUID
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
500: An internal exception was thrown.
/activity_sensordata:
description: Returns the activity sensordata as a collection of JSON objects. Sensor names are specified as a comma-separated list.
get:
queryParameters:
activity_id: UUID
sensors: List
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
500: An internal exception was thrown.
/activity_summarydata:
description: Returns data computed from the activity. Summmary items are specified as a comma-separated list.
get:
queryParameters:
activity_id: UUID
summary_items: List
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
500: An internal exception was thrown.
/update_activity_metadata:
description:
post:
queryParameters:
activity_id: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/create_new_lap:
description:
post:
queryParameters:
activity_id: UUID
lap start time: number
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/login:
description: Authenticates a username and password.
post:
queryParameters:
username: string
password: string
responses:
200: application/json
401: Failed authentication. The username and password were invalid, or not provided.
500: An internal exception was thrown.
/create_login:
description: Creates a new account.
post:
queryParameters:
username: string
realname: string
password1: string
password2: string
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
401: Failed authentication. The username and password were not provided or did not meet security requirements.
500: An internal exception was thrown.
/login_status:
description: Determines if the current user has a valid session token.
get:
responses:
200: string
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/logout:
description: Terminates the current user's session.
post:
responses:
200: string
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/update_email:
description: Updates the user's email address.
post:
queryParameters:
email: string
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/update_password:
description: Updates the user's password.
post:
queryParameters:
old_password: string
new_password1: string
new_password2: string
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_users_gear:
description: Removes the current user's gear (all of it).
post:
queryParameters:
password: string
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_users_activities:
description: Removes the current user's activity data (all of it).
post:
queryParameters:
password: string
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_user:
description: Removes the current user and all associated data.
post:
queryParameters:
password: string
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_devices:
description: Returns a list of JSON objects describing all of the devices claimed by the logged in user.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_all_activities:
description: Returns a list of JSON objects describing all of the user's activities and the activities of the user's friends.
get:
queryParameters:
start?: date-only
end?: date-only
start_time?: number
end_time?: number
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_my_activities:
description: Returns a list of JSON objects describing all of the user's activities.
get:
queryParameters:
start?: date-only
end?: date-only
start_time?: number
end_time?: number
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_activity:
description: Removes the specified activity.
post:
queryParameters:
activity_id: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/add_activity:
description: Used when manually creating an activity, such as when logging strength training activities.
post:
queryParameters:
Distance: number
Duration: number
time: number
activity_type: string
responses:
200:
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/upload_activity_file:
description: Creates a new activity from data contained with the appended file.
post:
responses:
200: UUID
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/upload_activity_photo:
description: Uploads a photo and associates it with an activity.
post:
queryParameters:
activity_id: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_activity_photos:
description: Lists all photos associated with an activity.
get:
queryParameters:
activity_id: UUID
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_activity_photo:
description: Deletes a photo and removes it from an activity.
post:
queryParameters:
activity_id: UUID
photo_id: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/create_tags_on_activity:
description: Sets the tags on an activity. Tags are provided in a dictionary {"tag0", "foo"|, {"tag1", "bar"), etc.
post:
queryParameters:
activity_id: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_tag_from_activity:
description: Deletes a tag from an activity.
post:
queryParameters:
activity_id: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_sensor_data:
description: Deletes the specified set of sensor data (power, cadence, heart rate, etc.) from an activity.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_matched_users:
description: Lists user's whose usernames match the search criteria. Results are limited to the first 100 users.
post:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_pending_friends:
description: Lists the users who are requesting friendship with the logged in user.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_friends:
description: Lists the users who are friends with the logged in user.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/request_to_be_friends:
description: Sends a request to friend another user.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/confirm_request_to_be_friends:
description: Takes a user to the pending friends list and adds them to the actual friends list.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/unfriend:
description: Removes a user from the list of users that are friends with the logged in user.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/trim_activity:
description:
post:
queryParameters:
activity_id: UUID
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/export_activity:
description: Returns the activity in the specified format.
get:
queryParameters:
activity_id: UUID
export_format: export_format_type
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/export_workout:
description: Returns the workout in the specified format.
get:
queryParameters:
workout_id: UUID
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/claim_device:
description: Associates the device specified by the unique identifier with the logged in user's account.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_tags:
description: Lists the tags for the specified activity.
get:
queryParameters:
activity_id: UUID
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/create_comment:
description: Adds a comment to the specified activity.
post:
queryParameters:
activity_id: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_comments:
description: Lists comments for the specified activity.
get:
queryParameters:
activity_id: UUID
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/create_gear:
description: Creates a new gear record for the current user, such as a new bike or pair of shoes.
post:
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_gear:
description: Lists gear associated with the current user.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_gear_defaults:
description: Lists the gear that is, by default, associated with each activity type.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/update_gear:
description: Updates the gear name or description.
post:
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/update_gear_defaults:
description: Updates the gear a user wants to associate with an activity type, by default, is received.
post:
queryParameters:
activity_type: string
gear_id: UUID
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_gear:
description: Delete's the specified gear record and all associated service records.
delete:
queryParameters:
gear_id: UUID
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/retire_gear:
description: Marks the specified gear as retired.
post:
queryParameters:
gear_id: UUID
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/create_service_record:
description: Appends service information for a piece of gear (intended for tracking bicycle service data).
post:
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_service_record:
description: Deletes service informatio for a piece of gear.
delete:
responses:
200: OK
401:
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/create_race:
description: Creates a race (workout goal) on a user's profile.
post:
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_race:
description: Removes a race (workout goal) on a user's profile.
delete:
responses:
200: OK
401:
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/update_settings:
description:
post:
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/update_profile:
description:
post:
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/update_visibility:
description: Updates activity visibility.
post:
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/refresh_analysis:
description: Schedules the specified activity for (re)analysis.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/refresh_personal_records:
description: Refreshes the cache of personal records in the event it may have become corrupted by deleting activities, or changing activity types.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/generate_workout_plan:
description: Schedules workout plan generation. Will generate workouts for the week.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_planned_workouts:
description: Lists planned/scheduled workouts.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/update_planned_workouts:
description: Replace all of a user's planned/scheduled workouts.
post:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_planned_workout:
description: Deletes a specified planned/scheduled workout.
delete:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_planned_workouts:
description: Deletes all of a user's planned/scheduled workouts.
delete:
queryParameters:
workout_id: UUID
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_interval_workouts:
description: Lists interval workouts.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/create_race:
description: Adds a race to the calendar.
post:
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/create_pace_plan:
description: Creates a pace plan.
post:
queryParameters:
name: string
description: string
target distance: number
target distance units: number
target time: number
target splits: number
target splits units: number
route: string
last updated time: number
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_pace_plans:
description: Lists pace plans.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_pace_plan:
description: Deletes the specified pace plan.
delete:
queryParameters:
id: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_workout_ical_url:
description: Returns a link to the ical url for their planned workouts.
get:
responses:
200: A URL string.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_location_description:
description: Returns the political location that corresponds to an activity.
get:
queryParameters:
activity_id: UUID
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_location_summary:
description: Returns the summary of all political locations in which activities have occurred. Result is a JSON string.
get:
responses:
200: A JSON formatted string.
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/activity_hash_from_id:
description: Given the activity hash, return sthe activity ID, or an error if not found. Only looks at the logged in user's activities.
get:
queryParameters:
activity_id: UUID
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/has_activity:
description: Given the activity ID has hash, returns whether or not the activity exists in the database for the logged in user.
get:
queryParameters:
activity_id: UUID
responses:
200: OK
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_personal_records:
description: Returns the user's personal records. Result is a JSON string.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_running_paces:
description: Returns the user's estimated running paces. Result is a JSON string.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_distance_for_tag:
description: Returns the amount of distance logged to activities with the given tag. Result is a JSON string.
get:
queryParameters:
tag: string
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_task_statuses:
description: Returns a description of all deferred tasks for the logged in user. Result is a JSON string.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_record_progression:
description: Returns an ordered list containing the time and activity ID of the user's record progression for the specified record and activity type, i.e. best running 5K. Result is a JSON string.
get:
queryParameters:
activity_type: string
record_name: string
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_user_setting:
description: Returns the value associated with the specified user setting.
get:
queryParameters:
requested setting: string
responses:
200: The value associated with the requested setting.
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/get_user_settings:
description: Returns a JSON list of values associated with the specified user settings. Input is a comma-separated list.
get:
queryParameters:
requested settings: List
responses:
200: The value associated with the requested setting.
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/estimate_vo2_max:
description: Returns the user's estimated VO2 max.
get:
responses:
200: The value.
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/estimate_bmi:
description: Returns the user's estimated BMI.
get:
responses:
200: The value.
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_power_zones:
description:
get:
queryParameters:
estimated ftp: number
responses:
200: The value associated with the requested setting.
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
500: An internal exception was thrown.
/list_hr_zones:
description:
get:
queryParameters:
max heart rate: number
estimated max heart rate: number
responses:
200: The value associated with the requested setting.
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
500: An internal exception was thrown.
/generate_api_key:
description: Generates a new API key for the logged in user.
post:
responses:
200: UUID
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/delete_api_key:
description: Deletes the specified API key.
delete:
queryParameters:
key: UUID
responses:
200: Empty string
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_api_keys:
description: Returns the API keys associated witht he logged in user.
get:
responses:
200: application/json
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/list_activity_types:
description: Returns the list of all activity types the software understands.
get:
responses:
200: application/json
500: An internal exception was thrown.
/list_workout_types_for_activity:
description: Returns a the list of workout types that that correspond with the given activity type (i.e. running has easy runs, tempo runs, etc.).
get:
responses:
200: application/json
500: An internal exception was thrown.
/list_unsynched_activities:
description: Returns any changes since the last time the device was synched.
get:
queryParameters:
timestamp: number
responsses:
200: application/json
/merge_activity_files:
description: Takes two files and attempts to merge them.
post:
responses:
200: The merged file
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.
/merge_activities:
description: Takes multiple activities (specified by their unique id) and attempts to merge them, replacing the earliest activity in the list.
post:
responses:
200: The activity ID of the merged activity.
400: Malformed request. Either required parameters were missing or the supplied parameters were malformed.
403: Failed authentication. The user is not logged in.
500: An internal exception was thrown.