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

Set value for Thermostat.

Request Information

URI Parameters

Name	Description	Type	Additional information
deviceId	Device ID	integer	Required
locationId		string	None.

Body Parameters

Model of ThermostatAction

ThermostatRequest

Name	Type	Additional information
UserId	integer	None.
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:

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

application/xml, text/xml

Sample:

<ThermostatRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Automation">
  <CoolSetPoint>5</CoolSetPoint>
  <CoolThreshold>3</CoolThreshold>
  <CurrentOpModeID>normal</CurrentOpModeID>
  <HeatSetPoint>4</HeatSetPoint>
  <HeatThreshold>2</HeatThreshold>
  <TempHoldTime>sample string 6</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>
  <UserId>1</UserId>
</ThermostatRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ListAutomationDeviceResults

Name	Description	Type	Additional 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>