2 rückgabewert (response), 1 json, 3 abfrageintervall – SMA SUNNY WEBBOX RPC Benutzerhandbuch

Seite 11

Advertising
background image

SMA Solar Technology AG

4  Prozedur-Konventionen

Bedienungsanleitung

SWebBoxRPC-BA-de-14

11

4.2 Rückgabewert (Response)

Das Datenaustauschformat der Rückgabe wird durch die im Prozeduraufruf übermittelte Zeichenfolge
Format festgelegt.
Derzeit stehen folgende Formate zur Verfügung:

• JSON

4.2.1 JSON

Der Rückgabewert eines Prozeduraufrufs besteht aus einem serialisierten JSON-Objekt, welches aus
den folgenden obligatorischen Objekten besteht:

version — Eine Zeichenfolge, welche die zugrunde liegende RPC-Version festlegt.
proc — Eine Zeichenfolge, die den Namen der ausgeführten Prozedur enthält.
id — Eine Zeichenfolge, welche der Zuordnung von Anfrage und Antwort dient. Enthält die ID

aus der zugehörigen Anfrage.

result — Das Ergebnis der Prozedurausführung als serialisiertes JSON-Objekt. Wenn durch

Auftreten eines Fehlers die Prozedur nicht erfolgreich ausgeführt werden konnte, wird an Stelle
dieses Objekts das error-Objekt übermittelt.

error — Ein Objekt, welches Im Fehlerfall eine Zeichenkette mit einer Beschreibung des

aufgetretenen Fehlers enthält. Bei fehlerfreier Prozedurausführung wird dieses Objekt nicht
übermittelt.

4.3 Abfrageintervall

Der Zeitraum zwischen zwei Abfragen sollte nicht kleiner als 30 Sekunden sein.

Advertising