Change Station Parameters

Request Parameters

Parameter	Description	Note
acl-priority	Priority which is given to the fist of allowed or forbidden addresses	Values: allow, deny. Default is allow
add-acl-allow	Add address to the list of allowed	Parameters can be defined several times in the request
add-acl-disallow	Add address to the list of forbidden	Parameters can be defined several times in the request
add-group	Add a group
city	City
delete-acl-allow	Delete address from the list of allowed	Parameters can be defined several times in the request
delete-acl-disallow	Delete address from the list of forbidden	Parameters can be defined several times in the request
delete-group	Delete a group
department	Department
description	Description
email	Change the station email
floor	Floor
id	Station identifier	Required parameter: yes
latitude	Latitude
longitude	Longitude
organization	Organization
parent-group	Parent group
password	Password
province	Province
room	Room
street	Street

If you set an empty value for the password parameter in a request, 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>, where:

Parameter	Description	Mandatory	Default value
<address>	IP address or domain name	yes
<mask>	network mask	no	255.255.255.255 (/32)
<protocol>	TCP/IP (including IPv6) protocol	no	TCP/IP

In the request with delete-acl-allow and delete-acl-disallow parameters, the network prefix must be specified. For example:

http://192.168.1.1:9080/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 set in the delete-group parameter, this group will not be deleted from the groups list (parameter is ignored).

If the current primary group is set in the delete-group parameter while primary group changing is performed (the parent-group parameter is set), the primary group will be changed and the old group will be deleted from the groups list.

Request Example

http://192.168.1.1:9080/api/stations/change.ds?id=1002&password=passwd&name=station1002&description=description

XML and JSON response structure examples are described below.

XML Response

<drweb-es-api api_version="4.3.0" timestamp="1495740729" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<station id="1002"/>
</drweb-es-api>

Description of XML Response Parameters

The <station /> element contains information about the modified station.

The <stations /> element attribute:

Attribute	Description
id	Identifier of changed station

JSON Response

{ "head": {
"status": true,

"timestamp": 1555740761,

"api": {
"version": 40300,
"versionString": 4.3.0},

"server": {
"name": "192.168.1.1",

"version": "12.00.0.201909260",
"uuid": "50171907-d21d-b211-b3fd-cc152f024d8c"}},

"data": {
"id": "1002"}}

Description of JSON Response Parameters

The data block contains information about the changed station.

The data block element:

Field name	Description
id	Identifier of changed station