PUT api/v1/locations/{locationId}/devices/{deviceId}/automation/control/thermostats/types/{typeId}
Control the carrier thermostat
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId | integer |
Required |
|
deviceId | integer |
Required |
|
typeId | byte |
Required |
Body Parameters
CarrierThermostatRequestInfoName | Description | Type | Additional information |
---|---|---|---|
Mode | byte |
None. |
|
Zones | Collection of CarrierThermostatZoneInfo |
None. |
Request Formats
application/json, text/json
Sample:
{ "Mode": 64, "Zones": [ { "ThermostatId": 1, "HeatSetPoint": 2, "CoolSetPoint": 3, "FanMode": 64 }, { "ThermostatId": 1, "HeatSetPoint": 2, "CoolSetPoint": 3, "FanMode": 64 } ] }
application/xml, text/xml
Sample:
<CarrierThermostatRequestInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation.Carrier"> <Mode>64</Mode> <Zones> <CarrierThermostatZoneInfo> <CoolSetPoint>3</CoolSetPoint> <FanMode>64</FanMode> <HeatSetPoint>2</HeatSetPoint> <ThermostatId>1</ThermostatId> </CarrierThermostatZoneInfo> <CarrierThermostatZoneInfo> <CoolSetPoint>3</CoolSetPoint> <FanMode>64</FanMode> <HeatSetPoint>2</HeatSetPoint> <ThermostatId>1</ThermostatId> </CarrierThermostatZoneInfo> </Zones> </CarrierThermostatRequestInfo>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BaseResults
CarrierThermostatResultInfoName | Description | Type | Additional information |
---|---|---|---|
ResultCode | integer |
None. |
|
ResultData | string |
None. |
|
Zones | Collection of CarrierThermostatResponseInfo |
None. |
Response Formats
application/json, text/json
Sample:
{ "ResultCode": 1, "ResultData": "sample string 2", "Zones": [ { "ThermostatId": 1, "EndTime": "sample string 2" }, { "ThermostatId": 1, "EndTime": "sample string 2" } ] }
application/xml, text/xml
Sample:
<CarrierThermostatResultInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation.Carrier"> <ResultCode>1</ResultCode> <ResultData>sample string 2</ResultData> <Zones> <CarrierThermostatResponseInfo> <EndTime>sample string 2</EndTime> <ThermostatId>1</ThermostatId> </CarrierThermostatResponseInfo> <CarrierThermostatResponseInfo> <EndTime>sample string 2</EndTime> <ThermostatId>1</ThermostatId> </CarrierThermostatResponseInfo> </Zones> </CarrierThermostatResultInfo>