--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>Seepark API documentation — seepark 0.1.0 documentation</title>
+
+ <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '0.1.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="top" title="seepark 0.1.0 documentation" href="#" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head>
+ <body role="document">
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <div class="section" id="seepark-api-documentation">
+<h1>Seepark API documentation<a class="headerlink" href="#seepark-api-documentation" title="Permalink to this headline">¶</a></h1>
+<dl class="get">
+<dt id="get--api-(version)-openweathermap-city-(cityid)">
+<code class="descname">GET </code><code class="descname">/api/</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><code class="descname">/openweathermap/city/</code><span class="sig-paren">(</span><em>cityid</em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-(version)-openweathermap-city-(cityid)" title="Permalink to this definition">¶</a></dt>
+<dd><p>List all data found for a city</p>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--api-(version)-sensor-type-(sensor_type)">
+<code class="descname">GET </code><code class="descname">/api/</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><code class="descname">/sensor/type/</code><span class="sig-paren">(</span><em>sensor_type</em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-(version)-sensor-type-(sensor_type)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return all data for a specific sensor type</p>
+<p>URL parameters:
+begin=<datetime>, optional, format like “2018-05-19T21:07:53”
+end=<datetime>, optional, format like “2018-05-19T21:07:53”
+mode=<full|consolidated>, optional. return all rows (default) or with lower resolution (for charts)
+format=<default|c3>, optional. return result as returned by sqlalchemy (default) or formatted for c3.js</p>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--api-(version)-sensor-id-(sensor_id)">
+<code class="descname">GET </code><code class="descname">/api/</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><code class="descname">/sensor/id/</code><span class="sig-paren">(</span><em>sensor_id</em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-(version)-sensor-id-(sensor_id)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return all data for a specific sensor</p>
+<p>URL parameters:
+begin=<datetime>, optional, format like “2018-05-19T21:07:53”
+end=<datetime>, optional, format like “2018-05-19T21:07:53”
+mode=<full|consolidated>, optional. return all rows (default) or with lower resolution (for charts)
+format=<default|c3>, optional. return result as returned by sqlalchemy (default) or formatted for c3.js</p>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--report-(int-year)-(int-month)">
+<code class="descname">GET </code><code class="descname">/report/</code><span class="sig-paren">(</span><em class="property">int: </em><em>year</em><span class="sig-paren">)</span><code class="descname">-</code><span class="sig-paren">(</span><em class="property">int: </em><em>month</em><span class="sig-paren">)</span><a class="headerlink" href="#get--report-(int-year)-(int-month)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Report for given year and month</p>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--api-(version)-openweathermap-cities">
+<code class="descname">GET </code><code class="descname">/api/</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><code class="descname">/openweathermap/cities</code><a class="headerlink" href="#get--api-(version)-openweathermap-cities" title="Permalink to this definition">¶</a></dt>
+<dd><p>List all city IDs found in the database</p>
+</dd></dl>
+
+<dl class="get">
+<dt id="get--api-(version)-sensors-">
+<code class="descname">GET </code><code class="descname">/api/</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><code class="descname">/sensors/</code><a class="headerlink" href="#get--api-(version)-sensors-" title="Permalink to this definition">¶</a></dt>
+<dd><p>List all sensors found in the database</p>
+</dd></dl>
+
+</div>
+<div class="section" id="indices-and-tables">
+<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
+<ul class="simple">
+<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
+</ul>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="#">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Seepark API documentation</a></li>
+<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+</ul>
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="#">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+ <div role="note" aria-label="source link">
+ <h3>This Page</h3>
+ <ul class="this-page-menu">
+ <li><a href="_sources/index.txt"
+ rel="nofollow">Show Source</a></li>
+ </ul>
+ </div>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2019, Gregor Herrmann; Philipp Spitzer; Chrisu Jähnl.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
+
+ |
+ <a href="_sources/index.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
ToastFreeware / chrisu / seepark.git / blobdiff