|
Request Parameters
Parameter
|
Description
|
Note
|
id
|
Station identifier
|
Required parameter
|
password
|
Password
|
|
description
|
Description
|
|
room
|
Room
|
|
street
|
Street
|
|
city
|
City
|
|
floor
|
Floor
|
|
province
|
Province
|
|
department
|
Department
|
|
organization
|
Organization
|
|
latitude
|
Latitude
|
|
longitude
|
Longitude
|
|
user-id
|
User identifier
|
|
parent-group
|
Parent group
|
|
email
|
Change the station email
|
|
add-group
|
Add a group
|
|
delete-group
|
Delete a group
|
|
add-acl-allow
|
Add address to the list of allowed
|
Can be defined in the request several times
|
add-acl-disallow
|
Add address to the list of forbidden
|
Can be defined in the request several times
|
delete-acl-allow
|
Delete address from the list of allowed
|
Can be defined in the request several times
|
delete-acl-disallow
|
Delete address from the list of forbidden
|
Can be defined in the request several times
|
acl-priority
|
Priority which is given to the fist of allowed or forbidden addresses
|
Values: allow, deny. Default is allow
|
block-begin
|
Blocking start date
|
Accepted format:
YYYYMMDD
or
YYYYMMDDHHmmss
|
block-end
|
Blocking end date
|
expires
|
License expiration date
|
rate
|
Tariff group
|
Basic or user tariff group identifier.
Basic tariff groups:
•2888b7ff-3625-465e-bcb8-957de17f6458—DrWeb Classic •2c213cd2-eba1-4a0e-9f76-95e5e756d48c—DrWeb Free •4e87fd11-4a35-4ec1-bedd-29669b357e35—DrWeb Mobile •91644cc3-1dc1-42dc-a41e-5ea001f5538d—DrWeb Premium •01fe9e60-6570-11de-b827-0002a5d5c51b—DrWeb Premium Server •ebe76ffc-69e1-4757-b2b3-41506832bc9b—DrWeb Standard •673b0574-d11d-b211-9b4e-de33edc4ef1b—Juridical Drweb Classic •382a6f16-d21d-b211-9b56-de33edc4ef1b—Juridical DrWeb Premium •800af701-d21d-b211-9b54-de33edc4ef1b—Juridical DrWeb Standard |
Specification format for add-acl-allow, add-acl-disallow, delete-acl-allow and delete-acl-disallow parameters is: <protocol>/<address>/<mask>, where:
Parameter
|
Description
|
Obligatory
|
Default value
|
<protocol>
|
TCP/IP (including IPv6) protocol
|
no
|
TCP/IP
|
<address>
|
IP address or domain name
|
yes
|
|
<mask>
|
network mask
|
no
|
255.255.255.255 (/32)
|
|
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
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1395740729" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<station id="1002"/>
</drweb-avdesk-api>
|
Description of XML Response Parameters
The <station /> element contains information about all stations.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Identifier of changed station
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1395740761,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"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 elements:
Field name
|
Description
|
id
|
Identifier of changed station
|
|
