Personal tools

Difference between revisions of "API r6"

From PhotoVoltaic Logger new generation

Jump to: navigation, search
(Created page with "Category:API<html> <div style="float:right;margin-left:1em;padding:1em;border:dashed gray 1px;font-size:small"> <strong>Routes</strong> <br...")
 
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Category:API]]<html>
+
[[Category:API]]
 +
<html>
 
         <div style="float:right;margin-left:1em;padding:1em;border:dashed gray 1px;font-size:small">
 
         <div style="float:right;margin-left:1em;padding:1em;border:dashed gray 1px;font-size:small">
 
             <strong>Routes</strong>
 
             <strong>Routes</strong>
Line 203: Line 204:
 
                 <a name="e2726af"></a>
 
                 <a name="e2726af"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/batch/:guid</tt>
+
                     <tt>[PUT] /api/r6/batch/:guid</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 249: Line 250:
 
                 <a name="667878a"></a>
 
                 <a name="667878a"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/channel/:guid/:attribute</tt>
+
                     <tt>[GET] /api/r6/channel/:guid/:attribute</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 269: Line 270:
 
                 <a name="e0a04c4"></a>
 
                 <a name="e0a04c4"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/channel/:guid/parent(/:attribute)</tt>
+
                     <tt>[GET] /api/r6/channel/:guid/parent(/:attribute)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 289: Line 290:
 
                 <a name="90797dc"></a>
 
                 <a name="90797dc"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/channel/:guid/stats</tt>
+
                     <tt>[GET] /api/r6/channel/:guid/stats</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 309: Line 310:
 
                 <a name="861f156"></a>
 
                 <a name="861f156"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/channel/:guid</tt>
+
                     <tt>[GET] /api/r6/channel/:guid</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 329: Line 330:
 
                 <a name="b84e881"></a>
 
                 <a name="b84e881"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[DELETE] /api/latest/channel/:id</tt>
+
                     <tt>[DELETE] /api/r6/channel/:id</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 349: Line 350:
 
                 <a name="717a9e4"></a>
 
                 <a name="717a9e4"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/channel</tt>
+
                     <tt>[PUT] /api/r6/channel</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 369: Line 370:
 
                 <a name="22529fa"></a>
 
                 <a name="22529fa"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/channels</tt>
+
                     <tt>[GET] /api/r6/channels</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 389: Line 390:
 
                 <a name="f4bbea4"></a>
 
                 <a name="f4bbea4"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/csv/:guid</tt>
+
                     <tt>[PUT] /api/r6/csv/:guid</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 431: Line 432:
 
                 <a name="e4934df"></a>
 
                 <a name="e4934df"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/data/:guid(/:p1(/:p2))</tt>
+
                     <tt>[GET] /api/r6/data/:guid(/:p1(/:p2))</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 451: Line 452:
 
                 <a name="f501060"></a>
 
                 <a name="f501060"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[DELETE] /api/latest/data/:guid/:timestamp</tt>
+
                     <tt>[DELETE] /api/r6/data/:guid/:timestamp</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 471: Line 472:
 
                 <a name="ad27f98"></a>
 
                 <a name="ad27f98"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[POST] /api/latest/data/:guid</tt>
+
                     <tt>[POST] /api/r6/data/:guid</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 498: Line 499:
 
                 <a name="b55f6ed"></a>
 
                 <a name="b55f6ed"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/data/:guid</tt>
+
                     <tt>[PUT] /api/r6/data/:guid</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 533: Line 534:
 
                 <a name="89ce7ae"></a>
 
                 <a name="89ce7ae"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/data/raw/:guid</tt>
+
                     <tt>[PUT] /api/r6/data/raw/:guid</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 560: Line 561:
 
                 <a name="c1f61e4"></a>
 
                 <a name="c1f61e4"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/data/stats</tt>
+
                     <tt>[GET] /api/r6/data/stats</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 580: Line 581:
 
                 <a name="aaf6c3d"></a>
 
                 <a name="aaf6c3d"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/daylight(/:offset)</tt>
+
                     <tt>[GET] /api/r6/daylight(/:offset)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 600: Line 601:
 
                 <a name="20b3901"></a>
 
                 <a name="20b3901"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/daylight/:latitude/:longitude(/:offset)</tt>
+
                     <tt>[GET] /api/r6/daylight/:latitude/:longitude(/:offset)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 620: Line 621:
 
                 <a name="f83ea6d"></a>
 
                 <a name="f83ea6d"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET|POST] /api/latest/hash</tt>
+
                     <tt>[GET|POST] /api/r6/hash</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 647: Line 648:
 
                 <a name="f4799fb"></a>
 
                 <a name="f4799fb"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[ANY] /api/latest/help</tt>
+
                     <tt>[ANY] /api/r6/help</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 667: Line 668:
 
                 <a name="79caa60"></a>
 
                 <a name="79caa60"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[ANY] /api/latest/helphtml</tt>
+
                     <tt>[ANY] /api/r6/helphtml</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 687: Line 688:
 
                 <a name="04571e8"></a>
 
                 <a name="04571e8"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/hierarchy</tt>
+
                     <tt>[GET] /api/r6/hierarchy</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 707: Line 708:
 
                 <a name="3d8f14f"></a>
 
                 <a name="3d8f14f"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/json/:path+</tt>
+
                     <tt>[GET] /api/r6/json/:path+</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 733: Line 734:
 
                 <a name="27e57b2"></a>
 
                 <a name="27e57b2"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[POST] /api/latest/json/:path+</tt>
+
                     <tt>[POST] /api/r6/json/:path+</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 753: Line 754:
 
                 <a name="ec83072"></a>
 
                 <a name="ec83072"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[POST] /api/latest/jsonencode</tt>
+
                     <tt>[POST] /api/r6/jsonencode</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 773: Line 774:
 
                 <a name="48f8769"></a>
 
                 <a name="48f8769"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[DELETE] /api/latest/log/:id</tt>
+
                     <tt>[DELETE] /api/r6/log/:id</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 793: Line 794:
 
                 <a name="5f68917"></a>
 
                 <a name="5f68917"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/log/:id</tt>
+
                     <tt>[GET] /api/r6/log/:id</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 813: Line 814:
 
                 <a name="45dce21"></a>
 
                 <a name="45dce21"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[POST] /api/latest/log/:id</tt>
+
                     <tt>[POST] /api/r6/log/:id</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 839: Line 840:
 
                 <a name="c5c87be"></a>
 
                 <a name="c5c87be"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/log/all(/:page(/:count))</tt>
+
                     <tt>[GET] /api/r6/log/all(/:page(/:count))</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 859: Line 860:
 
                 <a name="d302e18"></a>
 
                 <a name="d302e18"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/log</tt>
+
                     <tt>[PUT] /api/r6/log</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 885: Line 886:
 
                 <a name="1194b40"></a>
 
                 <a name="1194b40"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/ping</tt>
+
                     <tt>[GET] /api/r6/ping</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 905: Line 906:
 
                 <a name="6c02508"></a>
 
                 <a name="6c02508"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/status</tt>
+
                     <tt>[GET] /api/r6/status</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 925: Line 926:
 
                 <a name="5941515"></a>
 
                 <a name="5941515"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/store/:key</tt>
+
                     <tt>[GET] /api/r6/store/:key</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 937: Line 938:
 
                 </li>
 
                 </li>
 
                 <li>Available since:  
 
                 <li>Available since:  
                     <strong>r5</strong>
+
                     <strong>r6</strong>
 
                 </li>
 
                 </li>
 
             </ul>
 
             </ul>
Line 945: Line 946:
 
                 <a name="e0110f4"></a>
 
                 <a name="e0110f4"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/store/:key</tt>
+
                     <tt>[PUT] /api/r6/store/:key</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 957: Line 958:
 
                 </li>
 
                 </li>
 
                 <li>Available since:  
 
                 <li>Available since:  
                     <strong>r5</strong>
+
                     <strong>r6</strong>
 
                 </li>
 
                 </li>
 
             </ul>
 
             </ul>
Line 971: Line 972:
 
                 <a name="ec04b3c"></a>
 
                 <a name="ec04b3c"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/sunrise(/:date)</tt>
+
                     <tt>[GET] /api/r6/sunrise(/:date)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 991: Line 992:
 
                 <a name="63f75da"></a>
 
                 <a name="63f75da"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/sunrise/:latitude/:longitude(/:date)</tt>
+
                     <tt>[GET] /api/r6/sunrise/:latitude/:longitude(/:date)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,011: Line 1,012:
 
                 <a name="f76791c"></a>
 
                 <a name="f76791c"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/sunset(/:date)</tt>
+
                     <tt>[GET] /api/r6/sunset(/:date)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,031: Line 1,032:
 
                 <a name="10edd5c"></a>
 
                 <a name="10edd5c"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/sunset/:latitude/:longitude(/:date)</tt>
+
                     <tt>[GET] /api/r6/sunset/:latitude/:longitude(/:date)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,051: Line 1,052:
 
                 <a name="e15ce5f"></a>
 
                 <a name="e15ce5f"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/tariff/:id/:date</tt>
+
                     <tt>[GET] /api/r6/tariff/:id/:date</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,071: Line 1,072:
 
                 <a name="18a4c5d"></a>
 
                 <a name="18a4c5d"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/tariff/:id/time/:date(/:to)</tt>
+
                     <tt>[GET] /api/r6/tariff/:id/time/:date(/:to)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,091: Line 1,092:
 
                 <a name="5018384"></a>
 
                 <a name="5018384"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/tariff/:id</tt>
+
                     <tt>[GET] /api/r6/tariff/:id</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,111: Line 1,112:
 
                 <a name="949be4e"></a>
 
                 <a name="949be4e"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/tariff</tt>
+
                     <tt>[GET] /api/r6/tariff</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,131: Line 1,132:
 
                 <a name="48c0fa1"></a>
 
                 <a name="48c0fa1"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/time(/:format)</tt>
+
                     <tt>[GET] /api/r6/time(/:format)</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,151: Line 1,152:
 
                 <a name="29526ff"></a>
 
                 <a name="29526ff"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/translation</tt>
+
                     <tt>[GET] /api/r6/translation</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,171: Line 1,172:
 
                 <a name="e08daae"></a>
 
                 <a name="e08daae"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[DELETE] /api/latest/tree/:id</tt>
+
                     <tt>[DELETE] /api/r6/tree/:id</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,191: Line 1,192:
 
                 <a name="d361c03"></a>
 
                 <a name="d361c03"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/tree/:id</tt>
+
                     <tt>[GET] /api/r6/tree/:id</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,211: Line 1,212:
 
                 <a name="3d5ffad"></a>
 
                 <a name="3d5ffad"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/tree/:p_guid/:c_guid</tt>
+
                     <tt>[PUT] /api/r6/tree/:p_guid/:c_guid</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,231: Line 1,232:
 
                 <a name="b23a045"></a>
 
                 <a name="b23a045"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[PUT] /api/latest/tree/alias/:id</tt>
+
                     <tt>[PUT] /api/r6/tree/alias/:id</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
Line 1,251: Line 1,252:
 
                 <a name="9029c83"></a>
 
                 <a name="9029c83"></a>
 
                 <h3>
 
                 <h3>
                     <tt>[GET] /api/latest/tree</tt>
+
                     <tt>[GET] /api/r6/tree</tt>
 
                     <small>
 
                     <small>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>
 
                         <a style="margin-left:.5em" href="#top" title="back to top">^</a>

Latest revision as of 22:40, 28 February 2015

Routes

batch/:guid [PUT]
channel/:guid/:attribute [GET]
channel/:guid/parent(/:attribute) [GET]
channel/:guid/stats [GET]
channel/:guid [GET]
channel/:id [DELETE]
channel [PUT]
channels [GET]
csv/:guid [PUT]
data/:guid(/:p1(/:p2)) [GET]
data/:guid/:timestamp [DELETE]
data/:guid [POST]
data/:guid [PUT]
data/raw/:guid [PUT]
data/stats [GET]
daylight(/:offset) [GET]
daylight/:latitude/:longitude(/:offset) [GET]
hash [GET|POST]
help [ANY]
helphtml [ANY]
hierarchy [GET]
json/:path+ [GET]
json/:path+ [POST]
jsonencode [POST]
log/:id [DELETE]
log/:id [GET]
log/:id [POST]
log/all(/:page(/:count)) [GET]
log [PUT]
ping [GET]
status [GET]
store/:key [GET]
store/:key [PUT]
sunrise(/:date) [GET]
sunrise/:latitude/:longitude(/:date) [GET]
sunset(/:date) [GET]
sunset/:latitude/:longitude(/:date) [GET]
tariff/:id/:date [GET]
tariff/:id/time/:date(/:to) [GET]
tariff/:id [GET]
tariff [GET]
time(/:format) [GET]
translation [GET]
tree/:id [DELETE]
tree/:id [GET]
tree/:p_guid/:c_guid [PUT]
tree/alias/:id [PUT]
tree [GET]

Version r6

[PUT] /api/r6/batch/:guid ^

Save multiple reading values

  • API key required: yes
  • Available since: r2

Header

X-PVLng-CSV-RecordSeparator
Set record separator (if not semicolon) since r5, "TAB" as string will be also accepted
X-PVLng-CSV-Separator
Set data separator (if not comma) since r5, "TAB" as string will be also accepted

Payload

<timestamp>,<value>;...
timestamp and value data sets
<date time>,<value>;...
date time and value data sets
<date>,<time>,<value>;...
date, time and value data sets

[GET] /api/r6/channel/:guid/:attribute ^

Fetch specific channel attribute

  • API key required: yes
  • Available since: r3

[GET] /api/r6/channel/:guid/parent(/:attribute) ^

Fetch all attributes or a specific attribute from parent channel

  • API key required: yes
  • Available since: r4

[GET] /api/r6/channel/:guid/stats ^

Fetch channel statistics

  • API key required: yes
  • Available since: r5

[GET] /api/r6/channel/:guid ^

Fetch single channel attribute

  • API key required: yes
  • Available since: r3

[DELETE] /api/r6/channel/:id ^

Delete channel and its readings

  • API key required: yes
  • Available since: r4

[PUT] /api/r6/channel ^

Create channel

  • API key required: yes
  • Available since: r5

[GET] /api/r6/channels ^

Fetch all channels

  • API key required: yes
  • Available since: r3

[PUT] /api/r6/csv/:guid ^

Save multiple reading values from CSV

  • API key required: yes
  • Available since: r2

Header

X-PVLng-CSV-Separator
Set data separator (if not semicolon) since r5, "TAB" as string will be also accepted

Payload

<timestamp>;<value>
timestamp and value data row(s)
<date time>;<value>
date time and value data row(s)
<date>;<time>;<value>
date, time and value data row(s)

[GET] /api/r6/data/:guid(/:p1(/:p2)) ^

Read reading values

  • API key required: yes
  • Available since: r2

[DELETE] /api/r6/data/:guid/:timestamp ^

Delete a reading value

  • API key required: yes
  • Available since: r2

[POST] /api/r6/data/:guid ^

Update a reading value, timestamp is required here

  • API key required: yes
  • Available since: r4

Payload

{"data":"<value>","timestamp":"<timestamp>"}
JSON encoded value

[PUT] /api/r6/data/:guid ^

Save a reading value

  • API key required: yes
  • Available since: r2

Payload

{"data":"<value>"}
JSON encoded value, use server time
{"data":"<value>","timestamp":"<timestamp>"}
JSON encoded value, use provided timestamp
{"data":"<value>","timestamp":"<date time>"}
JSON encoded value, use provided date and time

[PUT] /api/r6/data/raw/:guid ^

Save raw data, channel decide what to do with them

  • API key required: yes
  • Available since: r4

Payload

raw data in any format
Channel have to handle it

[GET] /api/r6/data/stats ^

Fetch readings statistics

  • API key required: yes
  • Available since: r5

[GET] /api/r6/daylight(/:offset) ^

Check for daylight for configured location, accept additional minutes before/after

  • API key required: yes
  • Available since: r3

[GET] /api/r6/daylight/:latitude/:longitude(/:offset) ^

Check for daylight, accept additional minutes before/after

  • API key required: yes
  • Available since: r3

[GET|POST] /api/r6/hash ^

Create MD5 and SHA1 hashes and a slug for the given text

  • API key required: yes
  • Available since: r3

Payload

text
Text to make hashes for

[ANY] /api/r6/help ^

This help, overview of valid calls

  • API key required: yes
  • Available since: r1

[ANY] /api/r6/helphtml ^

This help in HTML for browsers, overview of valid calls

  • API key required: yes
  • Available since: r4

[GET] /api/r6/hierarchy ^

Alias for /api/latest/tree

  • API key required: yes
  • Available since: r5

[GET] /api/r6/json/:path+ ^

Extract a section/value from given JSON data from query string

  • API key required: yes
  • Available since: r1

Payload

...json/path/to/node/?json=<JSON data>

[POST] /api/r6/json/:path+ ^

Extract a section/value from given JSON data sended in request body e.g. from a file

  • API key required: yes
  • Available since: r1

[POST] /api/r6/jsonencode ^

Encode posted data to JSON

  • API key required: yes
  • Available since: r1

[DELETE] /api/r6/log/:id ^

Delete a log entry

  • API key required: yes
  • Available since: r2

[GET] /api/r6/log/:id ^

Read a log entry

  • API key required: yes
  • Available since: r2

[POST] /api/r6/log/:id ^

Update a log entry

  • API key required: yes
  • Available since: r2

Payload

{"scope":"...", "message":"..."}

[GET] /api/r6/log/all(/:page(/:count)) ^

Read all log entries, paginated for :page, :count entries

  • API key required: yes
  • Available since: r2

[PUT] /api/r6/log ^

Store new log entry, scope defaults to 'API latest'

  • API key required: yes
  • Available since: r2

Payload

{"scope":"...", "message":"..."}

[GET] /api/r6/ping ^

For new relic pinger

  • API key required: yes
  • Available since: r4

[GET] /api/r6/status ^

System status

  • API key required: yes
  • Available since: r2

[GET] /api/r6/store/:key ^

Retrieve a value for a key

  • API key required: yes
  • Available since: r6

[PUT] /api/r6/store/:key ^

Save a value for a key

  • API key required: yes
  • Available since: r6

Payload

["<data>"]

[GET] /api/r6/sunrise(/:date) ^

Get sunrise of day, using configured loaction

  • API key required: yes
  • Available since: r3

[GET] /api/r6/sunrise/:latitude/:longitude(/:date) ^

Get sunrise for location and day

  • API key required: yes
  • Available since: r3

[GET] /api/r6/sunset(/:date) ^

Get sunset of day, using configured loaction

  • API key required: yes
  • Available since: r3

[GET] /api/r6/sunset/:latitude/:longitude(/:date) ^

Get sunset of day

  • API key required: yes
  • Available since: r3

[GET] /api/r6/tariff/:id/:date ^

Extract tariff for a day

  • API key required: yes
  • Available since: r4

[GET] /api/r6/tariff/:id/time/:date(/:to) ^

Extract tariff for a day

  • API key required: yes
  • Available since: r4

[GET] /api/r6/tariff/:id ^

Extract a tariff

  • API key required: yes
  • Available since: r4

[GET] /api/r6/tariff ^

Extract all tariffs

  • API key required: yes
  • Available since: r4

[GET] /api/r6/time(/:format) ^

Deliver actual server time

  • API key required: yes
  • Available since: r4

[GET] /api/r6/translation ^

Extract english texts for translation

  • API key required: yes
  • Available since: r3

[DELETE] /api/r6/tree/:id ^

Delete channel from channel hierarchy

  • API key required: yes
  • Available since: r4

[GET] /api/r6/tree/:id ^

Fetch a channel and its direct child channels

  • API key required: yes
  • Available since: r5

[PUT] /api/r6/tree/:p_guid/:c_guid ^

Add channel to parent

  • API key required: yes
  • Available since: r5

[PUT] /api/r6/tree/alias/:id ^

Create alias from given hierarchy Id

  • API key required: yes
  • Available since: r4

[GET] /api/r6/tree ^

Fetch whole channels hierarchy

  • API key required: yes
  • Available since: r5