|
Request Parameters
Parameter
|
Description
|
Mandatory
|
block-begin
|
Blocking period start date (inclusive).
Specified in the format: YYYYMMDD or YYYYMMDDhhmmss.
|
no
|
block-end
|
Blocking period end date (inclusive).
Specified in the format: YYYYMMDD or YYYYMMDDhhmmss.
|
no
|
id
|
Group ID
|
yes
|
Request Example
https://192.168.1.1:9081/api/groups/blocking.ds?id=7ec98a70-5c83-11ea-512f-70a167e08535
|
XML and JSON response structure examples are described below.
XML Response Structure
<drweb-es-api api_version="4.3.2" timestamp="1584353601" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="2">
<station id="1004" status="failed"/>
<station id="1005" status="success"/>
</stations>
</drweb-es-api>
|
Description of XML Response Parameters
The <stations /> element contains information about modification of station blocking settings for a group specified in the request.
The <stations /> element attribute:
Attribute
|
Description
|
total
|
Total number of stations in a response
|
•The <station /> element contains information about modification of blocking settings for a specific station.
The <station /> element attributes:
Attribute
|
Description
|
id
|
Station ID
|
status
|
Blocking settings modification status:
•success—successfully blocked,
•failed—unable to block. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1584354370,
"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": {
"total": 2,
"list": {
"1004": "failed",
"1005": "success"}}}
|
Description of JSON Response Parameters
The data block contains information about modification of station blocking settings for a group specified in the request.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations in a response
|
list
|
A list with blocking settings modification results for each station
|
•The list block elements:
Field name
|
Description
|
Station ID
|
Blocking settings modification status:
•success—successfully blocked,
•failed—unable to block. |
|