2020-12-30 11:12:35 +01:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" / >
2021-10-17 09:28:56 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2021-07-16 20:21:49 +02:00
< title > Users — FitTrackee 0.4.9
2020-12-30 11:12:35 +01:00
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" / >
2021-01-10 11:16:43 +01:00
< link rel = "next" title = "Workouts" href = "workouts.html" / >
2020-12-30 11:12:35 +01:00
< 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" >
2021-10-17 09:28:56 +02:00
< script type = "text/javascript" src = "../_static/js/jquery-1.12.4.min.js " > < / script >
2020-12-30 11:12:35 +01:00
< script type = "text/javascript" src = "../_static/js/jquery-fix.js " > < / script >
2021-10-17 09:28:56 +02:00
< script type = "text/javascript" src = "../_static/bootstrap-3.4.1/js/bootstrap.min.js " > < / script >
2020-12-30 11:12:35 +01:00
< 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 >
2021-07-16 20:21:49 +02:00
< span class = "navbar-text navbar-version pull-left" > < b > 0.4.9
2020-12-30 11:12:35 +01:00
< / 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 >
2021-01-10 11:16:43 +01:00
< a href = "workouts.html" title = "Next Chapter: Workouts" > < span class = "glyphicon glyphicon-chevron-right visible-sm" > < / span > < span class = "hidden-sm hidden-tablet" > Workouts » < / span >
2020-12-30 11:12:35 +01:00
< / 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" >
2021-10-17 09:28:56 +02:00
< div class = "section" id = "users" >
2020-12-30 11:12:35 +01:00
< h1 > Users< a class = "headerlink" href = "#users" title = "Permalink to this headline" > ¶< / a > < / h1 >
< dl class = "http get" >
< dt id = "get--api-users" >
2021-02-17 14:20:55 +01:00
< code class = "sig-name descname" > < span class = "pre" > GET< / span > < / code > < code class = "sig-name descname" > < span class = "pre" > /api/users< / span > < / code > < a class = "headerlink" href = "#get--api-users" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-12-30 11:12:35 +01:00
< dd > < p > Get all users< / p >
< p > < strong > Example request< / 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/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 >
< ul class = "simple" >
< li > < p > with some query parameters< / p > < / li >
< / ul >
2021-01-10 11:16:43 +01:00
< div class = "highlight-http notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "nf" > GET< / span > < span class = "nn" > /api/users?order_by=workouts_count& par_page=5< / span > < span class = "kr" > HTTP< / span > < span class = "o" > /< / span > < span class = "m" > 1.1< / span >
2020-12-30 11:12:35 +01:00
< 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_sports" < / span > < span class = "p" > :< / span > < span class = "mi" > 3< / span > < span class = "p" > ,< / span >
2021-01-10 11:16:43 +01:00
< span class = "nt" > " nb_workouts" < / span > < span class = "p" > :< / span > < span class = "mi" > 6< / span > < span class = "p" > ,< / span >
2020-12-30 11:12:35 +01:00
< 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_sports" < / span > < span class = "p" > :< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span >
2021-01-10 11:16:43 +01:00
< span class = "nt" > " nb_workouts" < / span > < span class = "p" > :< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span >
2020-12-30 11:12:35 +01:00
< 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 > ) – < / 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 > ) – < / p > < / li >
< li > < p > < strong > per_page< / strong > (< em > integer< / em > ) – < / p > < / li >
< li > < p > < strong > q< / strong > (< em > string< / em > ) – < / p > < / li >
< li > < p > < strong > order_by< / strong > (< em > string< / em > ) – < code class = "docutils literal notranslate" > < span class = "pre" > username< / span > < / code > , < code class = "docutils literal notranslate" > < span class = "pre" > created_at< / span > < / code > ,
2021-01-10 11:16:43 +01:00
< code class = "docutils literal notranslate" > < span class = "pre" > workouts_count< / span > < / code > , < code class = "docutils literal notranslate" > < span class = "pre" > admin< / span > < / code > )< / p > < / li >
2020-12-30 11:12:35 +01:00
< li > < p > < strong > order< / strong > (< em > string< / em > ) – < code class = "docutils literal notranslate" > < span class = "pre" > asc< / 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 > – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Status Codes< / dt >
< dd class = "field-even" > < ul class = "simple" >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" > 200 OK< / a > – < / p > < / li >
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2" > 401 Unauthorized< / a > – < ul >
2020-12-30 11:12:35 +01:00
< 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)" >
2021-02-17 14:20:55 +01:00
< code class = "sig-name descname" > < span class = "pre" > GET< / span > < / code > < code class = "sig-name descname" > < span class = "pre" > /api/users/< / span > < / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "pre" > user_name< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#get--api-users-(user_name)" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-12-30 11:12:35 +01:00
< 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_sports" < / span > < span class = "p" > :< / span > < span class = "mi" > 3< / span > < span class = "p" > ,< / span >
2021-01-10 11:16:43 +01:00
< span class = "nt" > " nb_workouts" < / span > < span class = "p" > :< / span > < span class = "mi" > 6< / span > < span class = "p" > ,< / span >
2020-12-30 11:12:35 +01:00
< 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 > ) – < / p > < / li >
< li > < p > < strong > user_name< / strong > (< em > integer< / em > ) – < / 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 > – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-odd" > Status Codes< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" > 200 OK< / a > – < / p > < / li >
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2" > 401 Unauthorized< / a > – < ul >
2020-12-30 11:12:35 +01:00
< 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 >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5" > 404 Not Found< / a > – < ul >
2020-12-30 11:12:35 +01:00
< 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" >
2021-02-17 14:20:55 +01:00
< code class = "sig-name descname" > < span class = "pre" > GET< / span > < / code > < code class = "sig-name descname" > < span class = "pre" > /api/users/< / span > < / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "pre" > user_name< / span > < / em > < span class = "sig-paren" > )< / span > < code class = "sig-name descname" > < span class = "pre" > /picture< / span > < / code > < a class = "headerlink" href = "#get--api-users-(user_name)-picture" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-12-30 11:12:35 +01:00
< 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 > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Status Codes< / dt >
< dd class = "field-even" > < ul class = "simple" >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" > 200 OK< / a > – < / p > < / li >
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5" > 404 Not Found< / a > – < ul >
2020-12-30 11:12:35 +01:00
< 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 patch" >
< dt id = "patch--api-users-(user_name)" >
2021-02-17 14:20:55 +01:00
< code class = "sig-name descname" > < span class = "pre" > PATCH< / span > < / code > < code class = "sig-name descname" > < span class = "pre" > /api/users/< / span > < / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "pre" > user_name< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#patch--api-users-(user_name)" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-12-30 11:12:35 +01:00
< dd > < p > Update user to add admin rights< / p >
< p > Only user with admin rights can modify another user< / 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/users/< user_name> < / 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 >
2021-01-10 11:16:43 +01:00
< span class = "nt" > " nb_workouts" < / span > < span class = "p" > :< / span > < span class = "mi" > 6< / span > < span class = "p" > ,< / span >
2020-12-30 11:12:35 +01:00
< 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 > ) – < / p > < / li >
< li > < p > < strong > user_name< / strong > (< em > string< / em > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Request JSON Object< / dt >
< dd class = "field-even" > < ul class = "simple" >
< li > < p > < strong > admin< / strong > (< em > boolean< / em > ) – < / 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 > – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Status Codes< / dt >
< dd class = "field-even" > < ul class = "simple" >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" > 200 OK< / a > – < / p > < / li >
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2" > 401 Unauthorized< / a > – < ul >
2020-12-30 11:12:35 +01:00
< 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 >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4" > 403 Forbidden< / a > – < / p > < / li >
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5" > 404 Not Found< / a > – < ul >
2020-12-30 11:12:35 +01:00
< li > < p > User does not exist.< / p > < / li >
< / ul >
< / p > < / li >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1" > 500 Internal Server Error< / a > – < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "http delete" >
< dt id = "delete--api-users-(user_name)" >
2021-02-17 14:20:55 +01:00
< code class = "sig-name descname" > < span class = "pre" > DELETE< / span > < / code > < code class = "sig-name descname" > < span class = "pre" > /api/users/< / span > < / code > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "pre" > user_name< / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#delete--api-users-(user_name)" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-12-30 11:12:35 +01:00
< dd > < p > Delete a user account< / p >
< p > A user can only delete his own account< / p >
< p > An admin can delete all accounts except his account if he’
one admin< / 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/users/john_doe< / 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 > ) – < / p > < / li >
< li > < p > < strong > user_name< / strong > (< em > string< / em > ) – < / 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 > – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-odd" > Status Codes< / dt >
< dd class = "field-odd" > < ul class = "simple" >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5" > 204 No Content< / a > – < / p > < / li >
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2" > 401 Unauthorized< / a > – < ul >
2020-12-30 11:12:35 +01:00
< 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 >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4" > 403 Forbidden< / a > – < ul >
2020-12-30 11:12:35 +01:00
< li > < p > You do not have permissions.< / p > < / li >
< li > < p > You can not delete your account, no other user has admin rights.< / p > < / li >
< / ul >
< / p > < / li >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5" > 404 Not Found< / a > – < ul >
2020-12-30 11:12:35 +01:00
< li > < p > User does not exist.< / p > < / li >
< / ul >
< / p > < / li >
2021-10-17 09:28:56 +02:00
< li > < p > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1" > 500 Internal Server Error< / a > – < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
2021-10-17 09:28:56 +02:00
< / div >
2020-12-30 11:12:35 +01:00
< / div >
< / div >
< / div >
< footer class = "footer" >
< div class = "container" >
< p class = "pull-right" >
< a href = "#" > Back to top< / a >
< / p >
< p >
2021-04-06 14:03:42 +02:00
© Copyright 2018 - 2021, SamR1.< br / >
2021-10-17 09:28:56 +02:00
Created using < a href = "http://sphinx-doc.org/" > Sphinx< / a > 3.5.4.< br / >
2020-12-30 11:12:35 +01:00
< / p >
< / div >
< / footer >
< / body >
< / html >
