POST api/v1/locations/{locationId}/devices/{deviceId}/automation/thermostats

Set value for Thermostat.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
deviceId

Device ID

integer

Required

locationId

string

None.

Body Parameters

Model of ThermostatAction

ThermostatActionEx
NameDescriptionTypeAdditional information
ThermostatIDs

Collection of integer

None.

HeatThreshold

integer

None.

CoolThreshold

integer

None.

HeatSetPoint

integer

None.

CoolSetPoint

integer

None.

TempHoldTime

string

None.

CurrentOpModeID

StatCurrentOpMode

None.

ThermostatModeID

StatMode

None.

ThermostatFanModeID

StatFanMode

None.

Request Formats

application/json, text/json

Sample:
{
  "ThermostatIDs": [
    1,
    2
  ],
  "HeatThreshold": 1,
  "CoolThreshold": 2,
  "HeatSetPoint": 3,
  "CoolSetPoint": 4,
  "TempHoldTime": "sample string 5",
  "CurrentOpModeID": 0,
  "ThermostatModeID": 0,
  "ThermostatFanModeID": 0
}

application/xml, text/xml

Sample:
<ThermostatActionEx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Automation">
  <CoolSetPoint>4</CoolSetPoint>
  <CoolThreshold>2</CoolThreshold>
  <CurrentOpModeID>normal</CurrentOpModeID>
  <HeatSetPoint>3</HeatSetPoint>
  <HeatThreshold>1</HeatThreshold>
  <TempHoldTime>sample string 5</TempHoldTime>
  <ThermostatFanModeID>auto</ThermostatFanModeID>
  <ThermostatIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ThermostatIDs>
  <ThermostatModeID>off</ThermostatModeID>
</ThermostatActionEx>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ListAutomationDeviceResults
NameDescriptionTypeAdditional information
AutomationDevices

Collection of AutomationDeviceResults

None.

Response Formats

application/json, text/json

Sample:
{
  "AutomationDevices": [
    {
      "Id": 1,
      "ResultCode": 2,
      "ResultData": "sample string 3"
    },
    {
      "Id": 1,
      "ResultCode": 2,
      "ResultData": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<ListAutomationDeviceResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
  <AutomationDevices>
    <AutomationDeviceResults>
      <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">2</ResultCode>
      <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
      <Id>1</Id>
    </AutomationDeviceResults>
    <AutomationDeviceResults>
      <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">2</ResultCode>
      <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
      <Id>1</Id>
    </AutomationDeviceResults>
  </AutomationDevices>
</ListAutomationDeviceResults>