36
G. Lufft Mess- und Regeltechnik GmbH, Fellbach, Germany
11.3
API specification
11.3.1 Request specification
Each request is sent as a http-GET command.
http://<lufft-i-box-address>/
websites/ab/index.php/json/<devid>/api/<command>
<lufft-i-box-address>
network name or IP-address of the Lufft I-BOX
<devid>
Device ID as shown in API help page
<command>
for specified commands refer to next section
In the next section, the first part of the request:
http://<lufft-i-box-address>
/
websites/ab/index.php/json/<devid>/api
/
is named as <Base-URL>.
11.3.2 Response specification
All responses are in JSON format. For detailed JSON specification please refer to RFC 4627
(http://www.ietf.org/rfc/rfc4627.txt).
The responses in JSON fomat are coded with the UTF8 character set.
11.3.3 Response errors
All requests have a
„success“ field. Successful requests set this field to “true”, errors are
indicated with “false”. In case of an error, there are two additional fields: „errorno“ und
„errormsg“.
Response examples:
{ “success“: „false“,
„errno“: „01“ ,
„errormsg“:“required fields missing“,
}
{ “success“: „true“, ... }
11.4
API commands
11.4.1 Channel overview
Name
getchannels
description
returns a list of all active channels
URL
<Base-URL>/getchannels
parameter
-
response
success... „true“ on success, there are:
channel... list of channels
channelmetaid... internal channel id (Integer)
app
… name of app
