<!DOCTYPE html> <html> <head> <meta charset="utf-8" /> <title>Users — FitTrackee 0.2.5-beta documentation</title> <link rel="stylesheet" href="../_static/bootstrap-sphinx.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.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> <script src="../_static/language_data.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="Statistics" href="stats.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.2.5</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="#">Users</a></li> </ul> </ul> </li> <li> <a href="stats.html" title="Previous Chapter: Statistics"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Statistics</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/users.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"> <div class="section" id="users"> <h1>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h1> <dl class="http get"> <dt id="get--api-users"> <code class="sig-name descname">GET </code><code class="sig-name descname">/api/users</code><a class="headerlink" href="#get--api-users" title="Permalink to this definition">¶</a></dt> <dd><p>Get all users</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/users</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">"users"</span><span class="p">:</span> <span class="p">[</span> <span class="p">{</span> <span class="nt">"admin"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span> <span class="nt">"bio"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"birth_date"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"created_at"</span><span class="p">:</span> <span class="s2">"Sun, 14 Jul 2019 14:09:58 GMT"</span><span class="p">,</span> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"admin@example.com"</span><span class="p">,</span> <span class="nt">"first_name"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"language"</span><span class="p">:</span> <span class="s2">"en"</span><span class="p">,</span> <span class="nt">"last_name"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"location"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"nb_activities"</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span> <span class="nt">"nb_sports"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="nt">"picture"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> <span class="nt">"sports_list"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span> <span class="nt">"timezone"</span><span class="p">:</span> <span class="s2">"Europe/Paris"</span><span class="p">,</span> <span class="nt">"total_distance"</span><span class="p">:</span> <span class="mf">67.895</span><span class="p">,</span> <span class="nt">"total_duration"</span><span class="p">:</span> <span class="s2">"6:50:27"</span><span class="p">,</span> <span class="nt">"username"</span><span class="p">:</span> <span class="s2">"admin"</span> <span class="p">},</span> <span class="p">{</span> <span class="nt">"admin"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> <span class="nt">"bio"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"birth_date"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"created_at"</span><span class="p">:</span> <span class="s2">"Sat, 20 Jul 2019 11:27:03 GMT"</span><span class="p">,</span> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"sam@example.com"</span><span class="p">,</span> <span class="nt">"first_name"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"language"</span><span class="p">:</span> <span class="s2">"fr"</span><span class="p">,</span> <span class="nt">"last_name"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"location"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"nb_activities"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="nt">"nb_sports"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="nt">"picture"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> <span class="nt">"sports_list"</span><span class="p">:</span> <span class="p">[],</span> <span class="nt">"timezone"</span><span class="p">:</span> <span class="s2">"Europe/Paris"</span><span class="p">,</span> <span class="nt">"total_distance"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="nt">"total_duration"</span><span class="p">:</span> <span class="s2">"0:00:00"</span><span class="p">,</span> <span class="nt">"username"</span><span class="p">:</span> <span class="s2">"sam"</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 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> </ul> </dd> </dl> </dd></dl> <dl class="http get"> <dt id="get--api-users-(user_name)"> <code class="sig-name descname">GET </code><code class="sig-name descname">/api/users/</code><span class="sig-paren">(</span><em class="sig-param">user_name</em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-users-(user_name)" title="Permalink to this definition">¶</a></dt> <dd><p>Get single user details</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/users/admin</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="p">{</span> <span class="nt">"admin"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span> <span class="nt">"bio"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"birth_date"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"created_at"</span><span class="p">:</span> <span class="s2">"Sun, 14 Jul 2019 14:09:58 GMT"</span><span class="p">,</span> <span class="nt">"email"</span><span class="p">:</span> <span class="s2">"admin@example.com"</span><span class="p">,</span> <span class="nt">"first_name"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"language"</span><span class="p">:</span> <span class="s2">"en"</span><span class="p">,</span> <span class="nt">"last_name"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"location"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span> <span class="nt">"nb_activities"</span><span class="p">:</span> <span class="mi">6</span><span class="p">,</span> <span class="nt">"nb_sports"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="nt">"picture"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> <span class="nt">"sports_list"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">6</span> <span class="p">],</span> <span class="nt">"timezone"</span><span class="p">:</span> <span class="s2">"Europe/Paris"</span><span class="p">,</span> <span class="nt">"total_distance"</span><span class="p">:</span> <span class="mf">67.895</span><span class="p">,</span> <span class="nt">"total_duration"</span><span class="p">:</span> <span class="s2">"6:50:27"</span><span class="p">,</span> <span class="nt">"username"</span><span class="p">:</span> <span class="s2">"admin"</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>user_name</strong> (<em>integer</em>) – user name</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>User does not exist.</p></li> </ul> </p></li> </ul> </dd> </dl> </dd></dl> <dl class="http get"> <dt id="get--api-users-(user_name)-picture"> <code class="sig-name descname">GET </code><code class="sig-name descname">/api/users/</code><span class="sig-paren">(</span><em class="sig-param">user_name</em><span class="sig-paren">)</span><code class="sig-name descname">/picture</code><a class="headerlink" href="#get--api-users-(user_name)-picture" title="Permalink to this definition">¶</a></dt> <dd><p>get user picture</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/users/admin/picture</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">image/jpeg</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>user_name</strong> (<em>integer</em>) – user name</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.5">404 Not Found</a> – <ul> <li><p>User does not exist.</p></li> <li><p>No picture.</p></li> </ul> </p></li> </ul> </dd> </dl> </dd></dl> <dl class="http get"> <dt id="get--api-ping"> <code class="sig-name descname">GET </code><code class="sig-name descname">/api/ping</code><a class="headerlink" href="#get--api-ping" title="Permalink to this definition">¶</a></dt> <dd><p>health check endpoint</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/ping</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">"message"</span><span class="p">:</span> <span class="s2">"pong!"</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">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> </ul> </dd> </dl> </dd></dl> </div> </div> </div> </div> <footer class="footer"> <div class="container"> <p class="pull-right"> <a href="#">Back to top</a> </p> <p> © Copyright 2018 - 2019, SamR1.<br/> Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.3.<br/> </p> </div> </footer> </body> </html>