Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Station identifier.
This parameter can be defined in the request several times to request information on several stations with specified state at a time.
|
yes
|
Request Example
http://192.168.1.1:9080/api/stations/state.ds?id=d071625c-d21d-b211-9bc4-bc02713bf843
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1392870064" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<states>
<state id="d071625c-d21d-b211-9bc4-bc02713bf843">online</state>
</states>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <states /> element contains information on all stations with requested identifiers. ▫The <state /> element contains information on specific station. The element value is a station state. The <state /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
JSON Response Structure
{"head": {
"status": true,
"timestamp":1392280146,
"api":{
"version":40103
},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "a509dab1-d423-4059-971a-aa3944a2c48a"
}
},
"data":{
"states":{
"d071625c-d21d-b211-9bc4-bc02713bf843": "online"
}
}
}
|
Description of JSON Response Parameters
The states block contains information on all stations with requested identifiers.
The states block elements:
Field name
|
Description
|
Station Identifier
|
Station state
|
|