| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende ÜberarbeitungLetzte ÜberarbeitungBeide Seiten der Revision |
| development:api:reference [2016/07/19 15:11] – add "Messwerte löschen" schnello | development:api:reference [2019/04/01 11:28] – [Parameter] jay |
|---|
| |[integer]|eine Ganzzahl mit optionalem Vorzeichen|/[+-]?\d+/| | |[integer]|eine Ganzzahl mit optionalem Vorzeichen|/[+-]?\d+/| |
| |[float]|eine Gleitkommazahl;\\ Dezimalpunkt ist "."| | | |[float]|eine Gleitkommazahl;\\ Dezimalpunkt ist "."| | |
| |[timestamp]|hier sind alle Formate gemäß "[[http://de3.php.net/manual/en/datetime.formats.php|PHP Date and Time Formats]]" erlaubt;\\ es können aber auch einfach nur die Anzahl der ms nach 1970 angegeben werden;\\ alle Zeitangaben beziehen sich auf die [[http://de.wikipedia.org/wiki/Koordinierte_Weltzeit|Koordinierte Weltzeit (UTC)]]\\ Der timestamp ist in Millisekunden anzugeben!| | | |[timestamp]|hier sind alle Formate gemäß "[[http://php.net/manual/en/datetime.formats.php|PHP Date and Time Formats]]" erlaubt;\\ es können aber auch einfach nur die Anzahl der ms nach 1970 angegeben werden;\\ alle Zeitangaben beziehen sich auf die [[http://de.wikipedia.org/wiki/Koordinierte_Weltzeit|Koordinierte Weltzeit (UTC)]]\\ Der timestamp ist in Millisekunden anzugeben!| | |
| |[uuid]|jede nach [[http://www.ietf.org/rfc/rfc4122.txt|RFC4122]] valide UUID|/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/| | |[uuid]|jede nach [[http://www.ietf.org/rfc/rfc4122.txt|RFC4122]] valide UUID|/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/| |
| |[numeric]|ist [float] oder [integer]| | | |[numeric]|ist [float] oder [integer]| | |
| |&to=[timestamp]|Endzeitpunkt für die Messwertreihe\\ Wird hier ein [[http://php.net/manual/en/datetime.formats.relative.php|relativer Wert]] angegeben, bezieht sich dieser auf //&from//.\\ Ist //&from// nicht angegeben bezieht er sich auf //jetzt//|//jetzt//|ja| | |&to=[timestamp]|Endzeitpunkt für die Messwertreihe\\ Wird hier ein [[http://php.net/manual/en/datetime.formats.relative.php|relativer Wert]] angegeben, bezieht sich dieser auf //&from//.\\ Ist //&from// nicht angegeben bezieht er sich auf //jetzt//|//jetzt//|ja| |
| |
| * "week" ist derzeit nicht implementiert: https://github.com/volkszaehler/volkszaehler.org/blob/master/lib/Volkszaehler/Util/Aggregation.php#L56 | * "week" ist derzeit nicht implementiert: https://github.com/volkszaehler/volkszaehler.org/blob/master/lib/Util/Aggregation.php#L68 |
| |
| <note>Die Antwort wird in Form eines JSON-Arrays zurück geliefert. z.B.: | <note>Die Antwort wird in Form eines JSON-Arrays zurück geliefert. z.B.: |
| |
| ^Parameter^Beschreibung^Standardwert^optional^ | ^Parameter^Beschreibung^Standardwert^optional^ |
| |&ts=[timestamp]|Zeitpunkt der Messung|Zeit des Middlewareservers|ja| | |&ts=[timestamp]|Zeitpunkt der Messung|Zeit des Middlewareservers|nein| |
| |&from=[timestamp]|Startzeitpunkt für die Messwertreihe\\ Wird hier ein [[http://php.net/manual/en/datetime.formats.relative.php|relativer Wert]] angegeben, bezieht sich dieser auf //jetzt//.\\ Ist //&to// nicht angegeben bezieht er sich auf //jetzt - 24h//|(jetzt - 24h)|ja| | |&from=[timestamp]|Startzeitpunkt für die Messwertreihe\\ Wird hier ein [[http://php.net/manual/en/datetime.formats.relative.php|relativer Wert]] angegeben, bezieht sich dieser auf //jetzt//.\\ Ist //&to// nicht angegeben bezieht er sich auf //jetzt - 24h//|(jetzt - 24h)|nein| |
| |&to=[timestamp]|Endzeitpunkt für die Messwertreihe\\ Wird hier ein [[http://php.net/manual/en/datetime.formats.relative.php|relativer Wert]] angegeben, bezieht sich dieser auf //&from//.\\ Ist //&from// nicht angegeben bezieht er sich auf //jetzt//|//jetzt//|ja| | |&to=[timestamp]|Endzeitpunkt für die Messwertreihe\\ Wird hier ein [[http://php.net/manual/en/datetime.formats.relative.php|relativer Wert]] angegeben, bezieht sich dieser auf //&from//.\\ Ist //&from// nicht angegeben bezieht er sich auf //jetzt//|//jetzt//|ja| |
| |
| |txt|einfache Textausgabe|ja| | |txt|einfache Textausgabe|ja| |
| |csv|[[http://www.ietf.org/rfc/rfc4180.txt|Komma-separierte Werte]]|ja| | |csv|[[http://www.ietf.org/rfc/rfc4180.txt|Komma-separierte Werte]]|ja| |
| |png|Plotting Ausgabe mit [[http://jpgraph.net|jpGraph]]\\ Die Graphen werden durch die Middleware gerendert\\ und als Rastergrafik ausgegeben|(noch nicht implementiert)| | |png|Plotting Ausgabe mit [[http://jpgraph.net|jpGraph]]\\ Die Graphen werden durch die Middleware gerendert\\ und als Rastergrafik ausgegeben|ja (falls jpGraph installiert)| |
| |gif|:::|:::| | |gif|:::|:::| |
| |jpg|:::|:::| | |jpg|:::|:::| |
| |debug|integer|Debug Level (sollte größer 0 sein)|0|ja| | |debug|integer|Debug Level (sollte größer 0 sein)|0|ja| |
| |tsfmt|string|Zeitformat:|ms|ja| | |tsfmt|string|Zeitformat:|ms|ja| |
| | | |//sql//: yyyy-mm-dd HH:MM:SS| | | | | |//sql//: yyyy-mm-dd HH:MM:SS| |:::| |
| | | |//ms// (oder //unix//): Millisekunden seit 1.1.1970, 00:00 GMT|*| | | | | |//ms// (oder //unix//): Millisekunden seit 1.1.1970, 00:00 GMT|*|:::| |
| |options|string|Optionen|keine|ja| | |options|string|Optionen|keine|ja| |
| | | |//raw//: Daten ohne Verarbeitung ausgeben (z.B. Zählerstände)| | | | | | |//raw//: Daten ohne Verarbeitung ausgeben (z.B. Zählerstände)| |:::| |
| ==== JSON ==== | | | |//consumption//: Verbrauch ausgeben (Summe der Werte), für //group//| |:::| |
| ^Parameter^Beschreibung^ | | | |//skipduplicates//: Fehler beim Hinzufügen von Daten ignorieren (insbesondere Duplikate)| |:::| |
| |&padding=//funcname//|[[http://en.wikipedia.org/wiki/JSON#JSONP|JSON with padding]]| | |group|string|Ausgabe nach Zeitinterval aufsummieren: //year// //month// //week// //day// //hour// //minute// //second// \\ I.A. nur mit //options=consumption// sinnvoll. \\ Timestamp ist der jeweils letzte des Intervals.| - |ja| |
| |
| ==== Plotting ==== | ==== Plotting ==== |
