-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
277 lines (267 loc) · 17.9 KB
/
index.html
File metadata and controls
277 lines (267 loc) · 17.9 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to Athlete.com API’s documentation! — Athlete.com API 0.1.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Athlete.com API 0.1.0 documentation" href="#" />
<link rel="next" title="Overview" href="getting_started/overview.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="getting_started/overview.html" title="Overview"
accesskey="N">next</a> |</li>
<li><a href="#">Athlete.com API 0.1.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-athlete-com-api-s-documentation">
<h1>Welcome to Athlete.com API’s documentation!<a class="headerlink" href="#welcome-to-athlete-com-api-s-documentation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started/overview.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started/overview.html#documentation-format">Documentation Format</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/overview.html#request-format">Request Format</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/overview.html#response-format">Response Format</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/overview.html#standard-response-fields">Standard Response Fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/overview.html#units">Units</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started/patching.html">PATCHing</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started/authentication.html">Authentication</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started/authentication.html#client-authentication">Client Authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started/authentication.html#user-authentication">User Authentication</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started/testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started/testing.html#try-it">Try It!</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started/errors.html">Errors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started/errors.html#athlete-errors">Athlete Errors</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">ChangeLog</a></li>
</ul>
</div>
</div>
<div class="section" id="resources">
<h2>Resources<a class="headerlink" href="#resources" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="resources/authentication.html">Authentication</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/authentication.html#login">Login</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/authentication.html#register">Register</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/authentication.html#login-or-register-with-facebook">Login or Register with Facebook</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/authentication.html#forgot-password">Forgot password</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/user.html">Users</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/user.html#fetch-a-single-user">Fetch a single user</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/user.html#fetch-multiple-users">Fetch multiple users</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/user.html#search-users-by-name">Search users by name</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/user.html#search-for-friends">Search for friends</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/user.html#update-a-user">Update a user</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/user.html#change-profile-picture">Change profile picture</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/user.html#change-password">Change password</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/profile.html">Profiles</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/profile.html#get-a-profile">Get a profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/profile.html#update-a-profile">Update a profile</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/profile.html#specifying-a-location">Specifying a location</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/preferences.html">Preferences</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/preferences.html#get-preferences">Get preferences</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/preferences.html#update-preferences">Update Preferences</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/post.html">Posts (a.k.a. Feed)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#get-one-post">Get One Post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#paginating-posts">Paginating Posts</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#get-list-of-posts">Get List of Posts</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#delete-a-post">Delete a Post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#uploading-a-picture-to-a-post">Uploading a picture to a Post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#get-pictures-from-a-given-post">Get pictures from a given post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#extra-information-for-posts">Extra information for posts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/workout.html">Workouts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/workout.html#fetch-all-workouts-for-a-user">Fetch all workouts for a user</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/workout.html#create-a-workout-with-gpx-data">Create a workout with GPX data</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/workout.html#duplicate-workouts">Duplicate workouts</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/workout.html#create-a-workout-with-json-data">Create a workout with JSON data</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/workout.html#delete-a-workout">Delete a workout</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/workout.html#upload-route-data-to-a-workout">Upload route data to a workout</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/workout.html#share-a-workout">Share a workout</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/workout.html#content-types">Content Types</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/events.html">Events</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/events.html#get-an-eventinstance-resource">Get an EventInstance resource</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/events.html#event-particiapnts">Event Particiapnts</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/events.html#hotness">Hotness</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/route.html">Routes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/route.html#fetch-a-single-route">Fetch a single route</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/route.html#toggle-the-favorited-status-of-this-route-for-the-current-user">Toggle the favorited status of this route for the current user</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/photo_album.html">Photo Albums</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/photo_album.html#create-a-photo-album">Create a photo album</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/photo.html">Photos</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/photo.html#add-a-photo">Add a photo</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/photo.html#list-photos">List photos</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/comment.html">Comments</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/comment.html#create-a-comment">Create a comment</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/comment.html#get-a-comment">Get a comment</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/comment.html#get-comments-for-a-given-post">Get comments for a given post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/comment.html#delete-a-comment">Delete a comment</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/friendship.html">Friendships</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/friendship.html#get-friendships">Get friendships</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/friendship.html#get-friends-for-particular-user">Get friends for particular user</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/friendship.html#request-friendship">Request friendship</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/friendship.html#cancel-friendship-request-remove-friend">Cancel friendship request, Remove friend</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/friendship.html#accept-a-friend-request">Accept a friend request</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/friendship.html#search-for-friends">Search for friends</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/friendship.html#invite-a-friend-by-email">Invite a friend by email</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/friendship.html#friendship-exists-for-a-user">Friendship exists for a user</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/like.html">Likes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/like.html#toggle-a-like">Toggle a like</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/like.html#remove-a-like">Remove a like</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/post.html">Posts (a.k.a. Feed)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#get-one-post">Get One Post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#paginating-posts">Paginating Posts</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#get-list-of-posts">Get List of Posts</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#delete-a-post">Delete a Post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#uploading-a-picture-to-a-post">Uploading a picture to a Post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#get-pictures-from-a-given-post">Get pictures from a given post</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/post.html#extra-information-for-posts">Extra information for posts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/messages.html">Conversations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#get-conversations-for-inbox">Get Conversations for Inbox</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#get-conversations-for-archive">Get Conversations for Archive</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#get-one-conversation">Get One Conversation</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#mark-conversations-as-read">Mark conversations as read</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#id1">Get One Conversation</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#start-a-new-conversation">Start a new Conversation</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#archive-a-conversation">Archive a Conversation</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#hide-a-conversation">Hide a Conversation</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#get-all-messages">Get all Messages</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#post-a-new-message">Post a new Message</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources/messages.html#a-note-regarding-deleted-users-and-messages">A note regarding deleted users and messages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources/stats.html">Stats</a><ul>
<li class="toctree-l2"><a class="reference internal" href="resources/stats.html#get-stats-for-a-user">Get stats for a user</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to Athlete.com API’s documentation!</a><ul>
<li><a class="reference internal" href="#getting-started">Getting Started</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#resources">Resources</a><ul>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="getting_started/overview.html"
title="next chapter">Overview</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="getting_started/overview.html" title="Overview"
>next</a> |</li>
<li><a href="#">Athlete.com API 0.1.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, Athlete.com.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
</div>
</body>
</html>