Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Group identifier.
This parameter can be defined in the request several times to reboot stations of several groups at a time.
|
yes
|
message
|
Message to a user in a free form about the reason of reboot
|
yes
|
delay
|
Delay of station reboot in seconds. If the parameter is not set, then delay is 60 seconds
|
no
|
Request Example
http://192.168.1.1:9080/api/groups/reboot.ds?id=4&message=reboot&delay=45
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1392968284" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="0">
<station id="70200e02-d21d-b211-8a39-a00ca2f8be36" status="failed"/>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information on stations for which reboot has been requested. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations for which reboot has been requested
|
▫The <station /> element contains information on specific stations on which reboot has been requested. The <station /> element attributes:
Attribute
|
Description
|
ID
|
Station identifier
|
status
|
The state of reboot process. May take the following values:
•failed—attempt to reboot a station is failed, •initiated—reboot initiated. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp": 1392968319,
"api": {
"version": 40103
},
"server": {
"name": "192.168.1.1",
"version": 1000201707130,
"uuid": "7209d122-3b23-4134-94a9-0c1c645e21f3"
}
},
"data": {
"total": 0,
"list": [
{
"id": "70200e02-d21d-b211-8a39-a00ca2f8be36",
"status": "failed"
}
]
}
}
|
Description of JSON Response Parameters
The data block contains information on all stations for which reboot has been requested.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations for which reboot has been requested
|
•The list array contains information on specific stations on which reboot has been requested. Elements in the list array:
Field name
|
Description
|
id
|
Station identifier
|
status
|
The state of reboot process. May take the following values:
•failed—attempt to reboot a station is failed, •initiated—reboot initiated. |
|