Introduction; Version Hint; User Authentication; Units - IDS NXT Manual

3 Introduction

This documentation describes the REST interface (REST = Representational State Transfer) for IDS NXT
cameras. The REST interface allows you to send requests or commands such as GET or PUT etc. via HTTP
commands or to access data.

3.1 Version hint

The REST interface uses HTTP/1.1, other HTTP versions are not supported.
This document describes functions that are not available on every device, depending on the
model version / firmware version.

3.2 User authentication

User authentication is carried out using HTTP Basic.
The sub-pages specify the required user classes, split by HTTP method. The three default users are specified
with color coding.
·
User:
·
Service:
·
Admin (displayed as "Administrator"):
The following group authorizations exist:
Available with no group restriction and without authentication
Write parameters
Read parameters
(De)activate and (un)install vision apps
Set important device parameters and update
The default password for each user class is "ids". When you log in for the first time, you
must change the password to be able to log in. If you log in with the administrator profile, you
can change the passwords for the user classes "Service" and "User". This procedure is
described in the IDS NXT cockpit manual.
If you have not changed the default password, an error message "HTTP 901 Access denial
through default password" is returned for a REST request.

3.3 Units

Units of values are specified as "Unit". Units should be lower case compound SI units (with prefix) or "pixel". A
GUI should detect these units and display the correct localized version ("1000 millimeters" could be displayed
as "39.37 inch" in US-us and as "1 Meter" in De-de). Other units are possible, but in this case the GUI should
adopt them directly; localization is carried out using the Accept-Language-Header (translation only, not
conversion in this case). Specifying a unit is optional. If no unit is specified, the number is to be viewed as
dimensionless. A further unit is RFC 2822, which displays the specified date format.

3.4 Types

The following types are possible:
Type
String
StringList
March 2021
Qt/C++ equivalent
QString
QStringList
IDS NXT: REST interface
7