beautypg.com

2 return value (response), 1 json, 3 query interval – SMA SUNNY WEBBOX RPC User Manual

Page 10

background image

4  Procedure Conventions

SMA Solar Technology AG

10

SWebBoxRPC-BA-en-14

User Manual

4.2 Return Value (Response)

The data exchange format of the response is defined by the character sequence transmitted in the
request.
The following formats are currently available:

• JSON

4.2.1 JSON

The response to a request consists of a serialized JSON object made up of the following compulsory
objects:

version — a character sequence which defines the underlying RPC version.
proc — a character sequence which contains the called procedure.
id — a character sequence which serves to assign the request and response. Contains the ID

from the respective request.

result — the result of the executed procedure as a serialized JSON object. If due to an error the

procedure cannot be executed successfully, the "error" object will be transmitted instead.

error — an object containing a character string with a description of the error encountered. If

the procedure is executed without errors, this object will not be transmitted.

4.3 Query Interval

The interval between two queries should not be less than 30 seconds.