|
Request Parameters
Parameter
|
Description
|
Mandatory
|
acl-allow
|
Allowed address.
Can be repeated any number of times per request.
|
no
|
acl-disallow
|
Forbidden address.
Can be repeated any number of times per request.
|
no
|
acl-priority
|
Priority given to either allowed or forbidden address list.
Valid values: allow, deny. The default is allow.
|
no
|
city
|
City
|
no
|
country
|
Country.
Needs to be specified in the ISO format: RU, UA, etc.
|
no
|
department
|
Department
|
no
|
description
|
Description
|
no
|
email
|
Station email address
|
no
|
floor
|
Floor
|
no
|
group
|
Groups
|
no
|
id
|
Station ID.
If not specified, this parameter will be generated automatically.
|
no
|
latitude
|
Latitude.
Specified in the decimal format (for example, 38.898556, -77.037852).
|
no
|
longitude
|
Longitude.
Specified in the decimal format (for example, 38.898556, -77.037852).
|
no
|
name
|
Station name
|
no
|
organization
|
Organization
|
no
|
parent-group
|
Parent group
|
no
|
password
|
Password
|
no
|
province
|
Province
|
no
|
room
|
Room
|
no
|
street
|
Street
|
no
|
Specification format for the acl-allow and acl-disallow parameters: <protocol>/<address>/<mask>, including:
Parameter
|
Description
|
Mandatory
|
<address>
|
IP address or domain name
|
yes
|
<mask>
|
Network mask.
Default value: 255.255.255.255 (/32).
|
no
|
<protocol>
|
TCP/IP protocol (including IPv6).
Default value: TCP/IP.
|
no
|
Request Example
https://192.168.1.1:9081/api/stations/add.ds?id=1001&password=123456&name=station1234&acl-allow=192.168.1.1&acl-disallow=192.168.1.2&acl-priority=allow
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1582030254" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<station id="1001"/>
</drweb-es-api>
|
Description of XML Response Parameters
The <station /> element contains a newly created station ID.
The <station /> element attribute:
Attribute
|
Description
|
id
|
Station ID
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1582030511,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"id": "1001"}}
|
Description of JSON Response Parameters
The data block contains a newly created station ID.
The data block element:
Field name
|
Description
|
id
|
Station ID
|
|