GET api/RoomControl/getRoomState

<strong>get/getRoomState</strong> <br /> Gets the current room state (DND, MUR and Thermostat details).

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

JSON object in the form <code language="javascript"> { Dnd: "[Dnd]", Mur: "[Mur]", DevThermo: [{ ThermostatId: "[ThermostatIdentifier]", ActualTemp: "[ActualTemp]", FanMode: "[FanMode]", Setpoint: "[Setpoint]" }] } </code><table><tr><td><strong>Dnd</strong></td><td><c>boolean</c></td><td>True if Dnd is set else false </td></tr><tr><td><strong>Mur</strong></td><td><c>boolean</c></td><td>True if Mur is set else false</td></tr><tr><td colspan="3"><strong>List of DevThermo</strong></td></tr><tr><td><strong>ThermostatId</strong></td><td><c>string</c></td><td>The thermostat identifier</td></tr><tr><td><strong>ActualTemp</strong></td><td><c>decimal</c></td><td>Room current temperature</td></tr><tr><td><strong>FanMode</strong></td><td><c>string</c></td><td>The current fan mode (Low, Medium, High, Auto, Eco, Off)</td></tr><tr><td><strong>Setpoint</strong></td><td><c>decimal</c></td><td>Desire temperature set by user</td></tr></table>

DevRoomDetail
NameDescriptionTypeAdditional information
DevThermos

Collection of DevThermo

None.

Dnd

boolean

None.

Mur

boolean

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "DevThermos": [
    {
      "ActualTemp": 1.0,
      "FanSpeed": "sample string 1",
      "SetPoint": 1.0,
      "ThermostatId": "sample string 2"
    },
    {
      "ActualTemp": 1.0,
      "FanSpeed": "sample string 1",
      "SetPoint": 1.0,
      "ThermostatId": "sample string 2"
    }
  ],
  "Dnd": true,
  "Mur": true
}

application/xml, text/xml

Sample:
<DevRoomDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Interel.Common.Models">
  <DevThermos>
    <DevThermo>
      <ActualTemp>1</ActualTemp>
      <FanSpeed>sample string 1</FanSpeed>
      <SetPoint>1</SetPoint>
      <ThermostatId>sample string 2</ThermostatId>
    </DevThermo>
    <DevThermo>
      <ActualTemp>1</ActualTemp>
      <FanSpeed>sample string 1</FanSpeed>
      <SetPoint>1</SetPoint>
      <ThermostatId>sample string 2</ThermostatId>
    </DevThermo>
  </DevThermos>
  <Dnd>true</Dnd>
  <Mur>true</Mur>
</DevRoomDetail>