2020-12-30 11:12:35 +01:00
<!DOCTYPE html>
2022-06-22 20:22:26 +02:00
< html lang = "en" >
2020-12-30 11:12:35 +01:00
< head >
< meta charset = "utf-8" / >
2022-07-27 11:10:29 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.19: https://docutils.sourceforge.io/" / >
2021-11-03 12:41:23 +01:00
2023-06-03 15:37:15 +02:00
< title > Records — FitTrackee 0.7.17
2020-12-30 11:12:35 +01:00
documentation< / title >
2021-11-06 21:26:02 +01:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/bootstrap-sphinx.css" / >
2022-11-27 12:06:42 +01:00
< link rel = "stylesheet" type = "text/css" href = "../_static/css/fork-awesome.min.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/css/custom.css" / >
2021-11-06 21:26:02 +01:00
< script data-url_root = "../" id = "documentation_options" src = "../_static/documentation_options.js" > < / script >
2020-12-30 11:12:35 +01:00
< script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
2022-06-22 20:22:26 +02:00
< script src = "../_static/_sphinx_javascript_frameworks_compat.js" > < / script >
2020-12-30 11:12:35 +01:00
< script src = "../_static/doctools.js" > < / script >
2022-11-01 19:58:12 +01:00
< script src = "../_static/sphinx_highlight.js" > < / script >
2020-12-30 11:12:35 +01:00
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Sports" href = "sports.html" / >
2022-08-27 16:50:29 +02:00
< link rel = "prev" title = "OAuth2" href = "oauth2.html" / >
2020-12-30 11:12:35 +01:00
< 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" >
2022-02-05 22:09:17 +01:00
< script type = "text/javascript" src = "../_static/js/jquery-1.12.4.min.js" > < / script >
< script type = "text/javascript" src = "../_static/js/jquery-fix.js" > < / script >
< script type = "text/javascript" src = "../_static/bootstrap-3.4.1/js/bootstrap.min.js" > < / script >
< script type = "text/javascript" src = "../_static/bootstrap-sphinx.js" > < / script >
2020-12-30 11:12:35 +01:00
< / 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 >
2023-06-03 15:37:15 +02:00
< span class = "navbar-text navbar-version pull-left" > < b > 0.7.17
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 = "../features.html" > Features< / a > < / li >
2023-04-12 17:32:08 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../oauth.html" > OAuth 2.0< / a > < / li >
2021-11-29 18:24:22 +01:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../installation.html" > Installation< / a > < / li >
2022-04-24 13:17:38 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../cli.html" > Command line interface< / a > < / li >
2023-04-12 17:32:08 +02:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../third_party_tools.html" > Third-party tools< / a > < / li >
2020-12-30 11:12:35 +01:00
< 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 = "#" > Records< / a > < / li >
< / ul >
< / ul >
< / li >
< li >
2022-08-27 16:50:29 +02:00
< a href = "oauth2.html" title = "Previous Chapter: OAuth2" > < span class = "glyphicon glyphicon-chevron-left visible-sm" > < / span > < span class = "hidden-sm hidden-tablet" > « OAuth2< / span >
2020-12-30 11:12:35 +01:00
< / a >
< / li >
< li >
< a href = "sports.html" title = "Next Chapter: Sports" > < span class = "glyphicon glyphicon-chevron-right visible-sm" > < / span > < span class = "hidden-sm hidden-tablet" > Sports » < / span >
< / a >
< / li >
< li class = "hidden-sm" >
< div id = "sourcelink" >
< a href = "../_sources/api/records.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-11-06 21:26:02 +01:00
< section id = "records" >
2022-06-22 20:22:26 +02:00
< h1 > Records< a class = "headerlink" href = "#records" title = "Permalink to this heading" > ¶< / a > < / h1 >
2020-12-30 11:12:35 +01:00
< dl class = "http get" >
2021-11-06 21:26:02 +01:00
< dt class = "sig sig-object http" id = "get--api-records" >
< span class = "sig-name descname" > < span class = "pre" > GET< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > /api/records< / span > < / span > < a class = "headerlink" href = "#get--api-records" title = "Permalink to this definition" > ¶< / a > < / dt >
2020-12-30 11:12:35 +01:00
< dd > < p > Get all records for authenticated user.< / p >
< dl class = "simple" >
< dt > Following types of records are available:< / dt > < dd > < ul class = "simple" >
2022-07-27 11:10:29 +02:00
< li > < p > average speed (record_type: < code class = "docutils literal notranslate" > < span class = "pre" > AS< / span > < / code > )< / p > < / li >
< li > < p > farthest distance (record_type: < code class = "docutils literal notranslate" > < span class = "pre" > FD< / span > < / code > )< / p > < / li >
< li > < p > highest ascent (record_type: < code class = "docutils literal notranslate" > < span class = "pre" > HA< / span > < / code > )< / p > < / li >
< li > < p > longest duration (record_type: < code class = "docutils literal notranslate" > < span class = "pre" > LD< / span > < / code > )< / p > < / li >
< li > < p > maximum speed (record_type: < code class = "docutils literal notranslate" > < span class = "pre" > MS< / span > < / code > )< / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
< / dl >
2022-08-27 16:50:29 +02:00
< p > < strong > Scope< / strong > : < code class = "docutils literal notranslate" > < span class = "pre" > workouts:read< / span > < / code > < / p >
2020-12-30 11:12:35 +01:00
< 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/records< / 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 responses< / strong > :< / p >
< ul class = "simple" >
< li > < p > returning records< / 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 >
2023-02-16 11:18:50 +01:00
< span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " data" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " records" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > [< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 9< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " record_type" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " AS" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " sport_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " user" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " admin" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 18< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_date" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Sun, 07 Jul 2019 08:00:00 GMT" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " hvYBqYBRa7wwXpaStWR4V2" < / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 10< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " record_type" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " FD" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " sport_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " user" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " admin" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 18< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_date" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Sun, 07 Jul 2019 08:00:00 GMT" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " hvYBqYBRa7wwXpaStWR4V2" < / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 13< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " record_type" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " HA" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " sport_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " user" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Sam" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mf" > 43.97< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_date" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Sun, 07 Jul 2019 08:00:00 GMT" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " hvYBqYBRa7wwXpaStWR4V2" < / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 11< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " record_type" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " LD" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " sport_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " user" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " admin" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " 1:01:00" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_date" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Sun, 07 Jul 2019 08:00:00 GMT" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " hvYBqYBRa7wwXpaStWR4V2" < / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 12< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " record_type" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " MS" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " sport_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " user" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " admin" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " value" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "mi" > 18< / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_date" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " Sun, 07 Jul 2019 08:00:00 GMT" < / span > < span class = "p" > ,< / span >
< span class = "w" > < / span > < span class = "nt" > " workout_id" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " hvYBqYBRa7wwXpaStWR4V2" < / span >
< span class = "w" > < / span > < span class = "p" > }< / span >
< span class = "w" > < / span > < span class = "p" > ]< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "nt" > " status" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " success" < / span >
< span class = "p" > }< / span >
2020-12-30 11:12:35 +01:00
< / pre > < / div >
< / div >
< ul class = "simple" >
< li > < p > no records< / 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 >
2023-02-16 11:18:50 +01:00
< span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " data" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > {< / span >
< span class = "w" > < / span > < span class = "nt" > " records" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "p" > []< / span >
< span class = "w" > < / span > < span class = "p" > },< / span >
< span class = "w" > < / span > < span class = "nt" > " status" < / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " success" < / span >
< span class = "p" > }< / span >
2020-12-30 11:12:35 +01:00
< / pre > < / div >
< / div >
< dl class = "field-list simple" >
2022-06-22 20:22:26 +02:00
< dt class = "field-odd" > Request Headers< span class = "colon" > :< / span > < / dt >
2020-12-30 11:12:35 +01:00
< dd class = "field-odd" > < ul class = "simple" >
2022-11-27 12:06:42 +01:00
< li > < p > < span > < a class = "reference external" href = "https://www.rfc-editor.org/rfc/rfc7235#section-4.2" > Authorization< / a > < / span > – < / p > < / li >
2020-12-30 11:12:35 +01:00
< / ul >
< / dd >
2022-06-22 20:22:26 +02:00
< dt class = "field-even" > Status Codes< span class = "colon" > :< / span > < / dt >
2021-12-01 19:39:45 +01:00
< dd class = "field-even" > < ul class = "simple" >
2021-11-06 21:26:02 +01:00
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1" > 200 OK< / a > < / span > – < / p > < / li >
< li > < p > < span > < a class = "reference external" href = "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2" > 401 Unauthorized< / a > < / span > – < ul >
2021-11-03 12:41:23 +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 >
2020-12-30 11:12:35 +01:00
< / ul >
< / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
2021-11-06 21:26:02 +01:00
< / section >
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 >
2023-04-12 17:32:08 +02:00
© Copyright 2018 - 2023, SamR1 < a rel = "me" href = "https://fosstodon.org/@FitTrackee" > < i class = "fa fa-mastodon" aria-hidden = "true" > < / i > < / a > .
2023-06-03 15:37:15 +02:00
Last updated on Jun 03, 2023.< br / >
2022-11-01 19:58:12 +01:00
Created using < a href = "http://sphinx-doc.org/" > Sphinx< / a > 5.3.0.< br / >
2020-12-30 11:12:35 +01:00
< / p >
< / div >
< / footer >
2022-11-27 12:06:42 +01:00
2020-12-30 11:12:35 +01:00
< / body >
< / html >
