March 2021
8
IDS NXT: REST interface
Type
Qt/C++ equivalent
Integer
qint64
Boolean
bool
Double
double
3.5 Implemented services
Variable paths are specified in angle brackets (e.g. <appname>) and match [a-zA-Z]+[_a-zA-Z0-9-]*
The (partially exemplary) response to an OPTIONS request is shown here.
GET, DELETE etc. relate to the possible HTTP methods for the specified address. The JSON objects in the
level below specify the permitted or available MIME types. If no MIME type is specified, there is no restriction
here (for example for DELETE with blank response). Below the MIME types, there is then an Allowed=true and
a description. Variables provided are below values with description, name (used as the JSON object name)
and type (String, StringList -> JSonArray of Strings, Int) and, where appropriate, range (either array of
possible discrete values or minimum/maximum values). Values that are included in the URL as GET
parameters are flagged as "Parameters" (e.g. /camera/image?quality=50).
Unless otherwise specified, the default MIME type for POST/PUT/PATCH is application/x-www-
formurlencoded: The parameters/values are transferred in the same way as in an HTML form (in the body with
Parameter=Value&SecondParameter=Value2
).
If using application/x-www-form-urlencoded, the URL coding (percentage coding) must be used for special
characters, i.e. a space character is specified with "%20", etc.
The "Objects" array lists all subpaths. (For example the "avatar" object for
/deviceinfo
can be called
using /deviceinfo/avatar)
The possibility of using OPTIONS is only specified if this represents a variation from the default behavior
(application/json no parameters).
