Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Station identifier.
This parameter can be defined in the request several times to reboot several stations 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
|
no
|
Request Example
http://192.168.1.1:9080/api/stations/reboot.ds?id=d071625c-d21d-b211-9bc4-bc02713bf843&message=reboot%20now
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1392282677" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="1">
<station id="d071625c-d21d-b211-9bc4-bc02713bf843" status="failed"/>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information on all 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 is initiated. |
JSON Response Structure
{"head": {
"status": true,
"timestamp":1392282715,
"api":{
"version":40103
},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "a509dab1-d423-4059-971a-aa3944a2c48a"}},
"data":{
"total": 0,
"list": [ {
"id": "d071625c-d21d-b211-9bc4-bc02713bf843",
"status": "failed"} ]}}
|
Description of JSON Response Parameters
The data block contains information on all stations for which reboot has been requested.
The data block:
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 is initiated. |
|