![background image](http://html1.mh-extra.com/html/2n/indoor-touch/indoor-touch_api-manual_3088993025.webp)
2N TELEKOMUNIKACE a.s., www.2n.cz
25/42
{
"data"
: {
"success"
:
true
,
"array"
: [
{
"serial_number"
:
"54-0562-0293"
}
]
}
}
Make sure that the cover-all
container and the nested boolean
are always
data
success
included. Success is always true if the command has been (or is expected to have
been) executed successfully. Nevertheless, it cannot be guaranteed for the time being
that the success=true value really means success for all commands. For example, there
may be lack of success information for the commands that
2N Helios IP Mobile
®
resends to HIP and the value cannot be reported. Such commands include the PUT
method and the commands that do not return values: calls, opening doors, etc. Thus,
the user has to use another request (call/status, e.g.) to know the command's success.
The false value is returned for many reasons. At present, the HTTP API cannot
distinguish errors and specific error messages will be implemented in the next versions
if necessary. The short list of potential errors is as follows:
Request entering error – invalid argument values, missing arguments, non-
existent subsystem, wrong JSON data format, incorrect HTTP method, etc.
A
command is entered but the application is not running.
2N Helios IP Mobile
®
Therefore, make sure that the application has been started before sending a 2N
®
command.
Helios IP Mobile
The
container can include more items whose names and contents depend on the
data
request to be sent. Our example includes an array of serial numbers.
4.1.3 Cautions
Currently, API is used for both providing data to the web interface (REST) and user
HTTP API requirements. Thus, the data that can be viewed and configured via the web
can
be
available
in
API
despite
not
being
documented.
API now supports just one web interface login at a time. Hence, if a web interface is