|
Request Parameters
Parameter
|
Description
|
Note
|
Mandatory
|
id
|
Station identifier
|
If not set, an ID will be generated automatically
|
no
|
password
|
Password
|
|
no
|
rate
|
Tariff group
|
|
no
|
expires
|
Expiration date
|
0—unlimited,
otherwise—YYYYMMDDhhmmss
|
no
|
name
|
Station name
|
|
no
|
description
|
Description
|
|
no
|
room
|
Room
|
|
no
|
street
|
Street
|
|
no
|
city
|
City
|
|
no
|
country
|
Country
|
Specified in the ISO format: RU, UA and etc.
|
no
|
floor
|
Floor
|
|
no
|
province
|
Province
|
|
no
|
department
|
Department
|
|
no
|
organization
|
Organization
|
|
no
|
latitude
|
Latitude
|
Specified in decimal format: 38.898556, -77.037852
|
no
|
longitude
|
Longitude
|
|
no
|
parent-group
|
Parent group
|
|
no
|
email
|
Station e-mail
|
|
no
|
user-id
|
User identifier
|
|
no
|
latitude
|
Latitude
|
|
no
|
longitude
|
Longitude
|
no
|
block-begin
|
Blocking start date
|
Accepted format:
YYYYMMDD
or
YYYYMMDDHHmmss
|
no
|
block-end
|
Blocking end date
|
parent-group
|
Parent group
|
|
no
|
group
|
Groups
|
|
no
|
acl-allow
|
Allowed addresses
|
Can be defined several times in the request
|
no
|
acl-disallow
|
Forbidden addresses
|
|
no
|
acl-priority
|
Priority which is given to allowed or forbidden addresses
|
Values: allow, deny. Default is allow
|
no
|
Specification format for the acl-allow and acl-disallow parameters: <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)
|
Request Example
http://192.168.1.1:9080/api/stations/add.ds?id=1001&password=123456&name=station1234&description=description&country=RU&room=room123&street=street123&city=city123&floor=floor123&province=province123&department=department123&organization=organization123&latitude=-77.037852&longitude=38.898556&parent-group=1&group=1&email=mail@mail.ru&acl-allow=192.168.1.1&acl-disallow=192.168.1.2&acl-priority=allow&user-id=user1
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="112233"/>
</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 created station
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1393491700,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "7209d122-3b23-4134-94a9-0c1c645e21f3"
}
},
"data":{
"id": "112233"
}
}
|
Description of JSON Response Parameters
The data block contains information about the created station.
The data block elements:
Field name
|
Description
|
id
|
Identifier of created station
|
|
