Inhaltsverzeichnis
Werbung
11.3 API-Verhalten
11.3.1 Anfrage
Jede Anfrage erfolgt über den http-GET-Befehl
http://<lufft-i-box-adresse>/
websites/ab/index.php/json/<devid>/api/<befehl>
<lufft-i-box-adresse>
Nachfolgend wird der Beginn des Befehls
http://<lufft-i-box-adresse>/websites/ab/index.php/json/<devid>/api/
als <Base-URL> bezeichnet.
11.3.2 Antwort
Alle Abfrageergebnisse sind im Zeichensatz UTF8 kodiert.
Die Rückantwort des Systems erfolgt im Format JSON (JavaScript Object Notation).
Weiterführende Informationen zum Format JSON enthält die RFC 4627
(http://www.ietf.org/rfc/rfc4627.txt).
11.3.3 Fehlerbehandlung
Bei der erfolgreichen Verarbeitung des Befehls ist im JSON-Objekt die Eigenschaft
„success" auf „true" gesetzt. Bei nicht erfolgreicher Verarbeitung ist die Eigenschaft
„success" auf „false" und zusätzlich „errorno" und „errormsg" gesetzt.
Beispiele:
11.4 API-Befehle
11.4.1 Kanalübersicht
36
G. Lufft Mess- und Regeltechnik GmbH, Fellbach, Deutschland
<devid>
<befehl>
{ "success": „false",
„errno": „01" ,
„errormsg":"required fields missing"
}
{ "success": „true", ... }
Befehl
getchannels
Beschreibung
Es werden die Metadaten aller Kanäle zurückgegeben
URL
<Base-URL>/getchannels
Parameter
keine
success... „true" wenn kein Fehler aufgetreten, folgen:
Rückgabe
channel... Liste mit Kanälen mit jeweils den Eigenschaften
channelmetaid... Interne Kanalidentifizierung(Integer)
Netzwerkname oder IP-Adresse der Lufft I-BOX
Device ID (vgl. OUT JSON API-Hilfe)
siehe Kapitel „API-Befehle"
Werbung
Kapitel
Inhaltsverzeichnis
