Benutzer-Werkzeuge

Webseiten-Werkzeuge


development:api:reference

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
development:api:reference [2019/04/01 11:28]
jay [Parameter]
development:api:reference [2019/04/13 09:06] (aktuell)
justinotherguy URLs aktualisiert
Zeile 12: Zeile 12:
 Die URL besteht im Allgemeinen aus mehreren Komponenten:​ Die URL besteht im Allgemeinen aus mehreren Komponenten:​
  
-<​code>​http://<​server:​port><​einstiegspfad>/​middleware.php/<​kontext>​[/<​uuid>​].<​format>​[?<​parameter>​]</​code>​+<​code>​http://<​server:​port><​einstiegspfad>/​middleware/<​kontext>​[/<​uuid>​].<​format>​[?<​parameter>​]</​code>​
  
 ^Platzhalter^Beispiele^Mögliche Werte^Beschreibung^optional^ ^Platzhalter^Beispiele^Mögliche Werte^Beschreibung^optional^
Zeile 23: Zeile 23:
  
 Beispiel um die Auflösung eines Stromzählers in volkszähler-Datenbank nachträglich zu ändern: Beispiel um die Auflösung eines Stromzählers in volkszähler-Datenbank nachträglich zu ändern:
-<​code>​http://​demo.volkszaehler.org/​middleware.php/​channel/​[<​uuid>​].json?​operation=edit&​resolution=800</​code>​+<​code>​https://​demo.volkszaehler.org/​middleware/​channel/​[<​uuid>​].json?​operation=edit&​resolution=800</​code>​
  
 Beispiel um mehrer Kanäle abzufragen: Beispiel um mehrer Kanäle abzufragen:
-<​code>​http://​raspberrypi/​middleware.php/​data.json?​uuid[]=f2e145a0-84d5-11e4-86e3-3587832d7a7e&​uuid[]=57acbef0-88a9-11e4-934f-6b0f9ecd95a8</​code>​+<​code>​http://​raspberrypi/​middleware/​data.json?​uuid[]=f2e145a0-84d5-11e4-86e3-3587832d7a7e&​uuid[]=57acbef0-88a9-11e4-934f-6b0f9ecd95a8</​code>​
  
 ===== Typen ===== ===== Typen =====
Zeile 50: Zeile 50:
  
 <note tip>​Möchte man einfach nur schnell mal einen Operation im Browser testen kann auch ein normaler GET-Request in Kombination mit einem zusätzlichen Parameter genutzt werden. Bsp: <note tip>​Möchte man einfach nur schnell mal einen Operation im Browser testen kann auch ein normaler GET-Request in Kombination mit einem zusätzlichen Parameter genutzt werden. Bsp:
-<​code>​http://​demo.volkszaehler.org/​middleware.php/​channel.json?​operation=add&​title=Test Zähler</​code>​+<​code>​https://​demo.volkszaehler.org/​middleware/​channel.json?​operation=add&​title=Test Zähler</​code>​
 Bei der Angabe des "​operation"​-Parameters wird die Bestimmung der Operation durch die HTTP-Methode aufgehoben.</​note>​ Bei der Angabe des "​operation"​-Parameters wird die Bestimmung der Operation durch die HTTP-Methode aufgehoben.</​note>​
  
Zeile 81: Zeile 81:
 === Messwerte abfragen === === Messwerte abfragen ===
 **Beispiele** **Beispiele**
-<​code>​GET ​http://​demo.volkszaehler.org/​middleware.php/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​from=01-01-2010&​to=01-02-2010</​code>​ +<​code>​GET ​https://​demo.volkszaehler.org/​middleware/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​from=01-01-2010&​to=01-02-2010</​code>​ 
-<​code>​GET ​http://​demo.volkszaehler.org/​middleware.php/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​from=7+days+ago&​tuples=14</​code>​+<​code>​GET ​https://​demo.volkszaehler.org/​middleware/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​from=7+days+ago&​tuples=14</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 107: Zeile 107:
  
 **Beispiele** **Beispiele**
-<​code>​POST ​http://​demo.volkszaehler.org/​middleware.php/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​ts=1284677961150&​value=12</​code>​ +<​code>​POST ​https://​demo.volkszaehler.org/​middleware/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​ts=1284677961150&​value=12</​code>​ 
-<​code>​wget -O - -q "http://​demo.volkszaehler.org/​middleware.php/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​operation=add&​ts=1284677961150&​value=12"</​code>​+<​code>​wget -O - -q "https://​demo.volkszaehler.org/​middleware/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​operation=add&​ts=1284677961150&​value=12"</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 121: Zeile 121:
 **Beispiele** **Beispiele**
  
-<​code>​wget -O - -q "http://​demo.volkszaehler.org/​middleware.php/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​operation=delete&​ts=1284677961150"</​code>​ +<​code>​wget -O - -q "https://​demo.volkszaehler.org/​middleware/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​operation=delete&​ts=1284677961150"</​code>​ 
-<​code>​wget -O - -q "http://​demo.volkszaehler.org/​middleware.php/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​operation=delete&​from=1284677961150&​to=now"</​code>​+<​code>​wget -O - -q "https://​demo.volkszaehler.org/​middleware/​data/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​operation=delete&​from=1284677961150&​to=now"</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 137: Zeile 137:
  
 **Beispiel** **Beispiel**
-<​code>​GET ​http://​demo.volkszaehler.org/​middleware.php/​channel/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json</​code>​+<​code>​GET ​https://​demo.volkszaehler.org/​middleware/​channel/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json</​code>​
  
 === Kanal erstellen === === Kanal erstellen ===
Zeile 144: Zeile 144:
  
 **Beispiel** **Beispiel**
-<​code>​POST ​http://​demo.volkszaehler.org/​middleware.php/​channel.json?​type=power&​resolution=2000&​title=Testzähler</​code>​+<​code>​POST ​https://​demo.volkszaehler.org/​middleware/​channel.json?​type=power&​resolution=2000&​title=Testzähler</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 156: Zeile 156:
  
 **Beispiel** **Beispiel**
-<​code>​DELETE ​http://​demo.volkszaehler.org/​middleware.php/​channel/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json</​code>​+<​code>​DELETE ​https://​demo.volkszaehler.org/​middleware/​channel/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json</​code>​
  
 === Eigenschaften eines Kanals bearbeiten/​löschen === === Eigenschaften eines Kanals bearbeiten/​löschen ===
Zeile 163: Zeile 163:
  
 **Beispiel** **Beispiel**
-<​code>​PULL ​http://​demo.volkszaehler.org/​middleware.php/​channel/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​description=neue Beschreibung</​code>​+<​code>​PULL ​https://​demo.volkszaehler.org/​middleware/​channel/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​description=neue Beschreibung</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 176: Zeile 176:
  
 **Beispiel** **Beispiel**
-<​code>​GET ​http://​demo.volkszaehler.org/​middleware.php/​group/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json</​code>​+<​code>​GET ​https://​demo.volkszaehler.org/​middleware/​group/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json</​code>​
  
 === Gruppe erstellen === === Gruppe erstellen ===
Zeile 183: Zeile 183:
  
 **Beispiel** **Beispiel**
-<​code>​POST ​http://​demo.volkszaehler.org/​middleware.php/​group.json?​title=neue Gruppe</​code>​+<​code>​POST ​https://​demo.volkszaehler.org/​middleware/​group.json?​title=neue Gruppe</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 194: Zeile 194:
  
 **Beispiel** **Beispiel**
-<​code>​DELETE ​http://​demo.volkszaehler.org/​middleware.php/​group/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json</​code>​+<​code>​DELETE ​https://​demo.volkszaehler.org/​middleware/​group/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json</​code>​
  
 === Eigenschaften einer Gruppe bearbeiten/​löschen === === Eigenschaften einer Gruppe bearbeiten/​löschen ===
Zeile 201: Zeile 201:
  
 **Beispiel** **Beispiel**
-<​code>​PULL ​http://​demo.volkszaehler.org/​middleware.php/​group/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​title=neuer Titel</​code>​+<​code>​PULL ​https://​demo.volkszaehler.org/​middleware/​group/​57acbef0-88a9-11e4-934f-6b0f9ecd95a8.json?​title=neuer Titel</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 212: Zeile 212:
  
 **Beispiel** **Beispiel**
-<​code>​POST ​http://​demo.volkszaehler.org/​middleware.php/​group/​6836dd20-00d5-11e0-bab1-856ed5f959ae.json?​uuid=57acbef0-88a9-11e4-934f-6b0f9ecd95a8</​code>​+<​code>​POST ​https://​demo.volkszaehler.org/​middleware/​group/​6836dd20-00d5-11e0-bab1-856ed5f959ae.json?​uuid=57acbef0-88a9-11e4-934f-6b0f9ecd95a8</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 224: Zeile 224:
  
 **Beispiel** **Beispiel**
-<​code>​DELETE ​http://​demo.volkszaehler.org/​middleware.php/​group/​6836dd20-00d5-11e0-bab1-856ed5f959ae.json?​uuid=57acbef0-88a9-11e4-934f-6b0f9ecd95a8</​code>​+<​code>​DELETE ​https://​demo.volkszaehler.org/​middleware/​group/​6836dd20-00d5-11e0-bab1-856ed5f959ae.json?​uuid=57acbef0-88a9-11e4-934f-6b0f9ecd95a8</​code>​
  
 ^Parameter^Beschreibung^Standardwert^optional^ ^Parameter^Beschreibung^Standardwert^optional^
Zeile 233: Zeile 233:
  
 ** Beispiel ** ** Beispiel **
-<​code>​GET ​http://​demo.volkszaehler.org/​middleware.php/​capabilities/​definitions/​entities.json</​code>​ +<​code>​GET ​https://​demo.volkszaehler.org/​middleware/​capabilities/​definitions/​entities.json</​code>​ 
-<​code>​GET ​http://​demo.volkszaehler.org/​middleware.php/​capabilities/​database.json</​code>​+<​code>​GET ​https://​demo.volkszaehler.org/​middleware/​capabilities/​database.json</​code>​
  
 Es werden keine Parameter ausgewertet. Folgende Pfade sind verfügbar: Es werden keine Parameter ausgewertet. Folgende Pfade sind verfügbar:
  
 ^ Pfad ^ Beschreibung ^ ^ Pfad ^ Beschreibung ^
-|/​middleware.php/​capabilities|Alle Informationen| +|/​middleware/​capabilities|Alle Informationen| 
-|/​middleware.php/​capabilities/​statistics|Server Load, Uptime, Git-Hash| +|/​middleware/​capabilities/​statistics|Server Load, Uptime, Git-Hash| 
-|/​middleware.php/​capabilities/​configuration|Database Middleware, Debug Mode| +|/​middleware/​capabilities/​configuration|Database Middleware, Debug Mode| 
-|/​middleware.php/​capabilities/​definitions/​%%(properties|entities)%%|Liefert Definitionen von Entities oder deren Eigenschaften|+|/​middleware/​capabilities/​definitions/​%%(properties|entities)%%|Liefert Definitionen von Entities oder deren Eigenschaften|
  
 ====== Antwort ====== ====== Antwort ======
development/api/reference.txt · Zuletzt geändert: 2019/04/13 09:06 von justinotherguy