Klemsan TES-4, User Manual

Page: 24 / 35

TES has the interface to read device information, read / write configuration data, and read / delete recording
data, regardless of any program.
Using standard HTTP methods (GET, PUT, POST), the desired data can be read or written in JSON format.
This section describes the general communication parameters. The device communicates with two
different interfaces.
These interfaces are remote connection and USB. Unless otherwise specified, all parameters in the
document can be used for remote connection and communication via USB.
Authentication:
"Basic" authentication algorithm ensures communication security. The user name is always "user".
The user password is the password specified in the configuration.
Required HTTP Header Fields and Values
HTTP Method: GET | POST | PUT | DELETE
HTTP Version: HTTP/1.1 | HTTP/2
Server (Only valid on remote connection): Host:
AAA.BBB.CCC.DDD:PPP (IPAddress:PortNumber)
URL: The required data will be described in the following pages of the document
depending on the subjects.
Content Type: Content-Type: application/json
Authentication (Only valid on remote connection): Authorization: Basic xxxxxxxxxxxx
•
"Query Successful" Answer:
The answer is that the query is correct.
Code 200: OK.
•
"Query Inaccurate" Answer:
The answer is that the quary is wrong.
Code 400 Bad Request: This error will be returned if a non-valid request, incorrect
content type, unsupported http method, non-valid json parameter is sent.
Code 401 Unauthorized: This error will be returned if an incorrect user name /
password has been entered.
Code 404 Not Found: This error will be returned if the requested resource cannot be
found.
Transparent Ethernet /
Serial Gateway
TES
Transparent Ethernet /
Serial Converter
24
SECTION 4 JSON RestAPI
TES
SECTION 4 JSON RestAPI
4.1 General Communication Settings