1140 lines
87 KiB
HTML
1140 lines
87 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>Workouts — FitTrackee 0.4.7
|
||
documentation</title>
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/custom.css" />
|
||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="Troubleshooting" href="../troubleshooting/index.html" />
|
||
<link rel="prev" title="Users" href="users.html" />
|
||
<meta charset='utf-8'>
|
||
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
|
||
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
|
||
<meta name="apple-mobile-web-app-capable" content="yes">
|
||
<script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js "></script>
|
||
<script type="text/javascript" src="../_static/js/jquery-fix.js "></script>
|
||
<script type="text/javascript" src="../_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
|
||
<script type="text/javascript" src="../_static/bootstrap-sphinx.js "></script>
|
||
|
||
</head><body>
|
||
|
||
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
|
||
<div class="container">
|
||
<div class="navbar-header">
|
||
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
|
||
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
<span class="icon-bar"></span>
|
||
</button>
|
||
<a class="navbar-brand" href="../index.html">
|
||
FitTrackee</a>
|
||
<span class="navbar-text navbar-version pull-left"><b>0.4.7
|
||
</b></span>
|
||
</div>
|
||
|
||
<div class="collapse navbar-collapse nav-collapse">
|
||
<ul class="nav navbar-nav">
|
||
|
||
<li><a href="https://github.com/SamR1/FitTrackee">GitHub</a></li>
|
||
|
||
|
||
<li class="dropdown globaltoc-container">
|
||
<a role="button"
|
||
id="dLabelGlobalToc"
|
||
data-toggle="dropdown"
|
||
data-target="#"
|
||
href="../index.html">Docs <b class="caret"></b></a>
|
||
<ul class="dropdown-menu globaltoc"
|
||
role="menu"
|
||
aria-labelledby="dLabelGlobalToc"><ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../features.html">Features</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">API documentation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Change log</a></li>
|
||
</ul>
|
||
</ul>
|
||
</li>
|
||
|
||
<li class="dropdown">
|
||
<a role="button"
|
||
id="dLabelLocalToc"
|
||
data-toggle="dropdown"
|
||
data-target="#"
|
||
href="#">Page <b class="caret"></b></a>
|
||
<ul class="dropdown-menu localtoc"
|
||
role="menu"
|
||
aria-labelledby="dLabelLocalToc"><ul>
|
||
<li><a class="reference internal" href="#">Workouts</a></li>
|
||
</ul>
|
||
</ul>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
<li>
|
||
<a href="users.html" title="Previous Chapter: Users"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Users</span>
|
||
</a>
|
||
</li>
|
||
<li>
|
||
<a href="../troubleshooting/index.html" title="Next Chapter: Troubleshooting"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Troubleshooting »</span>
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
<li class="hidden-sm">
|
||
<div id="sourcelink">
|
||
<a href="../_sources/api/workouts.rst.txt"
|
||
rel="nofollow">Source</a>
|
||
</div></li>
|
||
|
||
</ul>
|
||
|
||
|
||
|
||
<form class="navbar-form navbar-right" action="../search.html" method="get">
|
||
<div class="form-group">
|
||
<input type="text" name="q" class="form-control" placeholder="Search" />
|
||
</div>
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="container">
|
||
<div class="row">
|
||
<div class="body col-md-12 content" role="main">
|
||
|
||
<section id="workouts">
|
||
<h1>Workouts<a class="headerlink" href="#workouts" title="Permalink to this headline">¶</a></h1>
|
||
<dl class="http get">
|
||
<dt id="get--api-workouts">
|
||
<code class="sig-name descname"><span class="pre">GET</span> </code><code class="sig-name descname"><span class="pre">/api/workouts</span></code><a class="headerlink" href="#get--api-workouts" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get workouts for the authenticated user.</p>
|
||
<p><strong>Example requests</strong>:</p>
|
||
<ul class="simple">
|
||
<li><p>without parameters</p></li>
|
||
</ul>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p>with some query parameters</p></li>
|
||
</ul>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts?from=2019-07-02&to=2019-07-31&sport_id=1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example responses</strong>:</p>
|
||
<ul class="simple">
|
||
<li><p>returning at least one workout</p></li>
|
||
</ul>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"workouts"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"ascent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"ave_speed"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"bounds"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"creation_date"</span><span class="p">:</span> <span class="s2">"Sun, 14 Jul 2019 13:51:01 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"descent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span><span class="p">,</span>
|
||
<span class="nt">"map"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_speed"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"min_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"modification_date"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"moving"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"next_workout"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"notes"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"pauses"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"previous_workout"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"records"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"MS"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"LD"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"FD"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"AS"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="nt">"segments"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"title"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"weather_end"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"weather_start"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"with_gpx"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p>returning no workouts</p></li>
|
||
</ul>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"workouts"</span><span class="p">:</span> <span class="p">[]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Query Parameters</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><strong>page</strong> (<em>integer</em>) – page if using pagination (default: 1)</p></li>
|
||
<li><p><strong>per_page</strong> (<em>integer</em>) – number of workouts per page
|
||
(default: 5, max: 100)</p></li>
|
||
<li><p><strong>sport_id</strong> (<em>integer</em>) – sport id</p></li>
|
||
<li><p><strong>from</strong> (<em>string</em>) – start date (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
|
||
<li><p><strong>to</strong> (<em>string</em>) – end date (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span></code>)</p></li>
|
||
<li><p><strong>distance_from</strong> (<em>float</em>) – minimal distance</p></li>
|
||
<li><p><strong>distance_to</strong> (<em>float</em>) – maximal distance</p></li>
|
||
<li><p><strong>duration_from</strong> (<em>string</em>) – minimal duration (format: <code class="docutils literal notranslate"><span class="pre">%H:%M</span></code>)</p></li>
|
||
<li><p><strong>duration_to</strong> (<em>string</em>) – maximal distance (format: <code class="docutils literal notranslate"><span class="pre">%H:%M</span></code>)</p></li>
|
||
<li><p><strong>ave_speed_from</strong> (<em>float</em>) – minimal average speed</p></li>
|
||
<li><p><strong>ave_speed_to</strong> (<em>float</em>) – maximal average speed</p></li>
|
||
<li><p><strong>max_speed_from</strong> (<em>float</em>) – minimal max. speed</p></li>
|
||
<li><p><strong>max_speed_to</strong> (<em>float</em>) – maximal max. speed</p></li>
|
||
<li><p><strong>order</strong> (<em>string</em>) – sorting order (default: <code class="docutils literal notranslate"><span class="pre">desc</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Request Headers</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Status Codes</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> – success</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http get">
|
||
<dt id="get--api-workouts-(string-workout_short_id)">
|
||
<code class="sig-name descname"><span class="pre">GET</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get an workout</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example responses</strong>:</p>
|
||
<ul class="simple">
|
||
<li><p>success</p></li>
|
||
</ul>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"workouts"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"ascent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"ave_speed"</span><span class="p">:</span> <span class="mi">16</span><span class="p">,</span>
|
||
<span class="nt">"bounds"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"creation_date"</span><span class="p">:</span> <span class="s2">"Sun, 14 Jul 2019 18:57:14 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"descent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="s2">"0:45:00"</span><span class="p">,</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span><span class="p">,</span>
|
||
<span class="nt">"map"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_speed"</span><span class="p">:</span> <span class="mi">16</span><span class="p">,</span>
|
||
<span class="nt">"min_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"modification_date"</span><span class="p">:</span> <span class="s2">"Sun, 14 Jul 2019 18:57:22 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"moving"</span><span class="p">:</span> <span class="s2">"0:45:00"</span><span class="p">,</span>
|
||
<span class="nt">"next_workout"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
|
||
<span class="nt">"notes"</span><span class="p">:</span> <span class="s2">"workout without gpx"</span><span class="p">,</span>
|
||
<span class="nt">"pauses"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"previous_workout"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"records"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"segments"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"title"</span><span class="p">:</span> <span class="s2">"biking on sunday morning"</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"weather_end"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"weather_start"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"with_gpx"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Sun, 07 Jul 2019 07:00:00 GMT"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<ul class="simple">
|
||
<li><p>acitivity not found:</p></li>
|
||
</ul>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">404</span> <span class="ne">NOT FOUND</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"workouts"</span><span class="p">:</span> <span class="p">[]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"not found"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
<li><p><strong>workout_short_id</strong> (<em>string</em>) – workout short id</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Request Headers</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Status Codes</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> – success</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4">403 Forbidden</a> – You do not have permissions.</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a> – workout not found</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http get">
|
||
<dt id="get--api-workouts-(string-workout_short_id)-gpx">
|
||
<code class="sig-name descname"><span class="pre">GET</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><code class="sig-name descname"><span class="pre">/gpx</span></code><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-gpx" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get gpx file for an workout displayed on map with Leaflet</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/gpx</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"gpx"</span><span class="p">:</span> <span class="s2">"gpx file content"</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
<li><p><strong>workout_short_id</strong> (<em>string</em>) – workout short id</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Request Headers</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Status Codes</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> – success</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a> – <ul>
|
||
<li><p>workout not found</p></li>
|
||
<li><p>no gpx file for this workout</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http get">
|
||
<dt id="get--api-workouts-(string-workout_short_id)-chart_data">
|
||
<code class="sig-name descname"><span class="pre">GET</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><code class="sig-name descname"><span class="pre">/chart_data</span></code><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-chart_data" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get chart data from an workout gpx file, to display it with Recharts</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/chart</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"chart_data"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="nt">"elevation"</span><span class="p">:</span> <span class="mf">279.4</span><span class="p">,</span>
|
||
<span class="nt">"latitude"</span><span class="p">:</span> <span class="mf">51.5078118</span><span class="p">,</span>
|
||
<span class="nt">"longitude"</span><span class="p">:</span> <span class="mf">-0.1232004</span><span class="p">,</span>
|
||
<span class="nt">"speed"</span><span class="p">:</span> <span class="mf">8.63</span><span class="p">,</span>
|
||
<span class="nt">"time"</span><span class="p">:</span> <span class="s2">"Fri, 14 Jul 2017 13:44:03 GMT"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mf">7.5</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="mi">7380</span><span class="p">,</span>
|
||
<span class="nt">"elevation"</span><span class="p">:</span> <span class="mi">280</span><span class="p">,</span>
|
||
<span class="nt">"latitude"</span><span class="p">:</span> <span class="mf">51.5079733</span><span class="p">,</span>
|
||
<span class="nt">"longitude"</span><span class="p">:</span> <span class="mf">-0.1234538</span><span class="p">,</span>
|
||
<span class="nt">"speed"</span><span class="p">:</span> <span class="mf">6.39</span><span class="p">,</span>
|
||
<span class="nt">"time"</span><span class="p">:</span> <span class="s2">"Fri, 14 Jul 2017 15:47:03 GMT"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
<li><p><strong>workout_short_id</strong> (<em>string</em>) – workout short id</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Request Headers</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Status Codes</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> – success</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a> – <ul>
|
||
<li><p>workout not found</p></li>
|
||
<li><p>no gpx file for this workout</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http get">
|
||
<dt id="get--api-workouts-(string-workout_short_id)-chart_data-segment-(int-segment_id)">
|
||
<code class="sig-name descname"><span class="pre">GET</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><code class="sig-name descname"><span class="pre">/chart_data/segment/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">segment_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-chart_data-segment-(int-segment_id)" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get chart data from an workout gpx file, to display it with Recharts</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/chart/segment/0</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"chart_data"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="nt">"elevation"</span><span class="p">:</span> <span class="mf">279.4</span><span class="p">,</span>
|
||
<span class="nt">"latitude"</span><span class="p">:</span> <span class="mf">51.5078118</span><span class="p">,</span>
|
||
<span class="nt">"longitude"</span><span class="p">:</span> <span class="mf">-0.1232004</span><span class="p">,</span>
|
||
<span class="nt">"speed"</span><span class="p">:</span> <span class="mf">8.63</span><span class="p">,</span>
|
||
<span class="nt">"time"</span><span class="p">:</span> <span class="s2">"Fri, 14 Jul 2017 13:44:03 GMT"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mf">7.5</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="mi">7380</span><span class="p">,</span>
|
||
<span class="nt">"elevation"</span><span class="p">:</span> <span class="mi">280</span><span class="p">,</span>
|
||
<span class="nt">"latitude"</span><span class="p">:</span> <span class="mf">51.5079733</span><span class="p">,</span>
|
||
<span class="nt">"longitude"</span><span class="p">:</span> <span class="mf">-0.1234538</span><span class="p">,</span>
|
||
<span class="nt">"speed"</span><span class="p">:</span> <span class="mf">6.39</span><span class="p">,</span>
|
||
<span class="nt">"time"</span><span class="p">:</span> <span class="s2">"Fri, 14 Jul 2017 15:47:03 GMT"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
<li><p><strong>workout_short_id</strong> (<em>string</em>) – workout short id</p></li>
|
||
<li><p><strong>segment_id</strong> (<em>integer</em>) – segment id</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Request Headers</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Status Codes</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> – success</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a> – no gpx file for this workout</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a> – workout not found</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http get">
|
||
<dt id="get--api-workouts-(string-workout_short_id)-gpx-segment-(int-segment_id)">
|
||
<code class="sig-name descname"><span class="pre">GET</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><code class="sig-name descname"><span class="pre">/gpx/segment/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">int:</span> </em><em class="sig-param"><span class="pre">segment_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-workouts-(string-workout_short_id)-gpx-segment-(int-segment_id)" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get gpx file for an workout segment displayed on map with Leaflet</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF/gpx/segment/0</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"gpx"</span><span class="p">:</span> <span class="s2">"gpx file content"</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"message"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
<li><p><strong>workout_short_id</strong> (<em>string</em>) – workout short id</p></li>
|
||
<li><p><strong>segment_id</strong> (<em>integer</em>) – segment id</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Request Headers</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Status Codes</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> – success</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a> – no gpx file for this workout</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a> – workout not found</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http get">
|
||
<dt id="get--api-workouts-map-(map_id)">
|
||
<code class="sig-name descname"><span class="pre">GET</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/map/</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">map_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-workouts-map-(map_id)" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get map image for workouts with gpx</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/map/fa33f4d996844a5c73ecd1ae24456ab8?1563529507772</span>
|
||
<span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">image/png</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>map_id</strong> (<em>string</em>) – workout map id</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Status Codes</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> – success</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a> – map does not exist</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http get">
|
||
<dt id="get--api-workouts-map_tile-(s)-(z)-(x)-(y).png">
|
||
<code class="sig-name descname"><span class="pre">GET</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/map_tile/</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">s</span></em><span class="sig-paren">)</span><code class="sig-name descname"><span class="pre">/</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">z</span></em><span class="sig-paren">)</span><code class="sig-name descname"><span class="pre">/</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">x</span></em><span class="sig-paren">)</span><code class="sig-name descname"><span class="pre">/</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="pre">y</span></em><span class="sig-paren">)</span><code class="sig-name descname"><span class="pre">.png</span></code><a class="headerlink" href="#get--api-workouts-map_tile-(s)-(z)-(x)-(y).png" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get map tile from tile server.</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">GET</span> <span class="nn">/api/workouts/map_tile/c/13/4109/2930.png</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">image/png</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>s</strong> (<em>string</em>) – subdomain</p></li>
|
||
<li><p><strong>z</strong> (<em>string</em>) – zoom</p></li>
|
||
<li><p><strong>x</strong> (<em>string</em>) – index of the tile along the map’s x axis</p></li>
|
||
<li><p><strong>y</strong> (<em>string</em>) – index of the tile along the map’s y axis</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p>Status codes are status codes returned by tile server</p>
|
||
</dd></dl>
|
||
|
||
<dl class="http post">
|
||
<dt id="post--api-workouts">
|
||
<code class="sig-name descname"><span class="pre">POST</span> </code><code class="sig-name descname"><span class="pre">/api/workouts</span></code><a class="headerlink" href="#post--api-workouts" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Post an workout with a gpx file</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/workouts/</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">multipart/form-data</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"workouts"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"ascent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"ave_speed"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"bounds"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"creation_date"</span><span class="p">:</span> <span class="s2">"Sun, 14 Jul 2019 13:51:01 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"descent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span><span class="p">,</span>
|
||
<span class="nt">"map"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_speed"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"min_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"modification_date"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"moving"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"next_workout"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"notes"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"pauses"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"previous_workout"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"records"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"MS"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"LD"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span><span class="p">,</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"FD"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"AS"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="nt">"segments"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"title"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"weather_end"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"weather_start"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"with_gpx"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Form Parameters</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><strong>file</strong> – gpx file (allowed extensions: .gpx, .zip)</p></li>
|
||
<li><p><strong>data</strong> – sport id and notes (example: <code class="docutils literal notranslate"><span class="pre">{"sport_id":</span> <span class="pre">1,</span> <span class="pre">"notes":</span> <span class="pre">""}</span></code>)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Request Headers</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Status Codes</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.2">201 Created</a> – workout created</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a> – <ul>
|
||
<li><p>Invalid payload.</p></li>
|
||
<li><p>No file part.</p></li>
|
||
<li><p>No selected file.</p></li>
|
||
<li><p>File extension not allowed.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.14">413 Request Entity Too Large</a> – Error during picture update: file size exceeds 1.0MB.</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http post">
|
||
<dt id="post--api-workouts-no_gpx">
|
||
<code class="sig-name descname"><span class="pre">POST</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/no_gpx</span></code><a class="headerlink" href="#post--api-workouts-no_gpx" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Post an workout without gpx file</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">POST</span> <span class="nn">/api/workouts/no_gpx</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">201</span> <span class="ne">CREATED</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"workouts"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"ascent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"ave_speed"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"bounds"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"creation_date"</span><span class="p">:</span> <span class="s2">"Sun, 14 Jul 2019 13:51:01 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"descent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"map"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_speed"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"min_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"modification_date"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"moving"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"next_workout"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"notes"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"pauses"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"previous_workout"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"records"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"MS"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"LD"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"FD"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"AS"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="nt">"segments"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"title"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"uuid"</span><span class="p">:</span> <span class="nt">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="nt">"weather_end"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"weather_start"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"with_gpx"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Request JSON Object</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><strong>workout_date</strong> (<em>string</em>) – workout date (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span> <span class="pre">%H:%M</span></code>)</p></li>
|
||
<li><p><strong>distance</strong> (<em>float</em>) – workout distance in km</p></li>
|
||
<li><p><strong>duration</strong> (<em>integer</em>) – workout duration in seconds</p></li>
|
||
<li><p><strong>notes</strong> (<em>string</em>) – notes (not mandatory)</p></li>
|
||
<li><p><strong>sport_id</strong> (<em>integer</em>) – workout sport id</p></li>
|
||
<li><p><strong>title</strong> (<em>string</em>) – workout title</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Request Headers</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Status Codes</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.2">201 Created</a> – workout created</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a> – invalid payload</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http patch">
|
||
<dt id="patch--api-workouts-(string-workout_short_id)">
|
||
<code class="sig-name descname"><span class="pre">PATCH</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#patch--api-workouts-(string-workout_short_id)" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Update an workout</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">PATCH</span> <span class="nn">/api/workouts/1</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">200</span> <span class="ne">OK</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
|
||
<span class="p">{</span>
|
||
<span class="nt">"data"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="nt">"workouts"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"ascent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"ave_speed"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"bounds"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"creation_date"</span><span class="p">:</span> <span class="s2">"Sun, 14 Jul 2019 13:51:01 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"descent"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"distance"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"duration"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"map"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"max_speed"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"min_alt"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"modification_date"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"moving"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"next_workout"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"notes"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"pauses"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"previous_workout"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"records"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"MS"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"LD"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="s2">"0:17:04"</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"FD"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span><span class="p">,</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="nt">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"record_type"</span><span class="p">:</span> <span class="s2">"AS"</span><span class="p">,</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"value"</span><span class="p">:</span> <span class="mf">10.0</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span><span class="p">,</span>
|
||
<span class="nt">"workout_id"</span><span class="p">:</span> <span class="s2">"kjxavSTUrJvoAh2wvCeGEF"</span><span class="p">,</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="nt">"segments"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="nt">"sport_id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
||
<span class="nt">"title"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"user"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
|
||
<span class="nt">"uuid"</span><span class="p">:</span> <span class="nt">"kjxavSTUrJvoAh2wvCeGEF"</span>
|
||
<span class="nt">"weather_end"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"weather_start"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
|
||
<span class="nt">"with_gpx"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
|
||
<span class="nt">"workout_date"</span><span class="p">:</span> <span class="s2">"Mon, 01 Jan 2018 00:00:00 GMT"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">},</span>
|
||
<span class="nt">"status"</span><span class="p">:</span> <span class="s2">"success"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
<li><p><strong>workout_short_id</strong> (<em>string</em>) – workout short id</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Request JSON Object</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><strong>workout_date</strong> (<em>string</em>) – workout date (format: <code class="docutils literal notranslate"><span class="pre">%Y-%m-%d</span> <span class="pre">%H:%M</span></code>)
|
||
(only for workout without gpx)</p></li>
|
||
<li><p><strong>distance</strong> (<em>float</em>) – workout distance in km
|
||
(only for workout without gpx)</p></li>
|
||
<li><p><strong>duration</strong> (<em>integer</em>) – workout duration in seconds
|
||
(only for workout without gpx)</p></li>
|
||
<li><p><strong>notes</strong> (<em>string</em>) – notes</p></li>
|
||
<li><p><strong>sport_id</strong> (<em>integer</em>) – workout sport id</p></li>
|
||
<li><p><strong>title</strong> (<em>string</em>) – workout title</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Request Headers</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Status Codes</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a> – workout updated</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1">400 Bad Request</a> – invalid payload</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a> – workout not found</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="http delete">
|
||
<dt id="delete--api-workouts-(string-workout_short_id)">
|
||
<code class="sig-name descname"><span class="pre">DELETE</span> </code><code class="sig-name descname"><span class="pre">/api/workouts/</span></code><span class="sig-paren">(</span><em class="property"><span class="pre">string:</span> </em><em class="sig-param"><span class="pre">workout_short_id</span></em><span class="sig-paren">)</span><a class="headerlink" href="#delete--api-workouts-(string-workout_short_id)" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete an workout</p>
|
||
<p><strong>Example request</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="nf">DELETE</span> <span class="nn">/api/workouts/kjxavSTUrJvoAh2wvCeGEF</span> <span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Example response</strong>:</p>
|
||
<div class="highlight-http notranslate"><div class="highlight"><pre><span></span><span class="kr">HTTP</span><span class="o">/</span><span class="m">1.1</span> <span class="m">204</span> <span class="ne">NO CONTENT</span>
|
||
<span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>auth_user_id</strong> (<em>integer</em>) – authenticate user id (from JSON Web Token)</p></li>
|
||
<li><p><strong>workout_short_id</strong> (<em>string</em>) – workout short id</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Request Headers</dt>
|
||
<dd class="field-even"><ul class="simple">
|
||
<li><p><a class="reference external" href="https://tools.ietf.org/html/rfc7235#section-4.2">Authorization</a> – OAuth 2.0 Bearer Token</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-odd">Status Codes</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5">204 No Content</a> – workout deleted</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">401 Unauthorized</a> – <ul>
|
||
<li><p>Provide a valid auth token.</p></li>
|
||
<li><p>Signature expired. Please log in again.</p></li>
|
||
<li><p>Invalid token. Please log in again.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5">404 Not Found</a> – workout not found</p></li>
|
||
<li><p><a class="reference external" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1">500 Internal Server Error</a> – Error. Please try again or contact the administrator.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<footer class="footer">
|
||
<div class="container">
|
||
<p class="pull-right">
|
||
<a href="#">Back to top</a>
|
||
|
||
</p>
|
||
<p>
|
||
© Copyright 2018 - 2021, SamR1.<br/>
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.3.<br/>
|
||
</p>
|
||
</div>
|
||
</footer>
|
||
</body>
|
||
</html> |