Change Station Parameters

Request Parameters

Parameter	Description	Mandatory
acl-priority	Priority given to either allowed or forbidden address list. Valid values: allow, deny. Default is allow.	no
add-acl-allow	Add an address to allowed address list. Can be repeated any number of times per request.	no
add-acl-disallow	Add an address to forbidden address list. Can be repeated any number of times per request.	no
add-group	Add a group	no
city	City	no
delete-acl-allow	Delete an address from allowed address list. Can be repeated any number of times per request.	no
delete-acl-disallow	Delete an address from forbidden address list. Can be repeated any number of times per request.	no
delete-group	Delete a group	no
department	Department	no
description	Description	no
email	Change the station email address	no
floor	Floor	no
id	Station ID	yes
latitude	Latitude	no
longitude	Longitude	no
organization	Organization	no
parent-group	Parent group	no
password	Password	no
country	Country. The parameter is set in the ISO format: RU, UA, etc.	no
province	Province	no
room	Room	no
street	Street	no

If you set an empty value for the password parameter in a request, the password will be changed.

Specification format for add-acl-allow, add-acl-disallow, delete-acl-allow and delete-acl-disallow parameters is: <protocol>/<address>/<mask>, including:

Parameter

Description

Mandatory

IP address or domain name

yes

<mask>

Network mask.

Default value: 255.255.255.255 (/32).

TCP/IP protocol (including IPv6).

Default value: TCP/IP.

In order to process a request correctly using the delete-acl-allow and delete-acl-disallow parameters, make sure to include the network prefix. For example:

https://192.168.1.1:9081/api/stations/change.ds?id=1002&delete-acl-allow=192.168.10.34/32&delete-acl-disallow=192.168.10.1/32

If the current primary group is specified in the delete-group parameter, this group will not be deleted from the group list (i.e., the parameter will be ignored).

If the current primary group is specified in the delete-group parameter and the primary group is changed at the same time (i.e., the parent-group parameter is specified as well), the primary group will be changed and the old group will be deleted from the group list.

Request Example

https://192.168.1.1:9081/api/stations/change.ds?id=1002&password=password&name=station1002&description=description

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="1002"/>
</drweb-es-api>

Description of XML Response Parameters

The <station /> element contains an ID of the station, parameters of which have been changed.

The <stations /> 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": "1002"}}

Description of JSON Response Parameters

The data block contains an ID of the station, parameters of which have been changed.

The data block element:

Field name	Description
id	Station ID