svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

ControlMultiFamilyThermostat

Execute a action on a Automation panel thermostat

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.alarmnet.com/TC2/ControlMultiFamilyThermostat"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ControlMultiFamilyThermostat xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <listMultiFamliyThermostatInfo>
        <Thermostats>
          <MultiFamliyThermostatInfo>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceID>long</DeviceID>
            <ThermostatID>long</ThermostatID>
            <ThermostatName>string</ThermostatName>
            <ThermostatIndex>short</ThermostatIndex>
            <CurrentOpMode>short</CurrentOpMode>
            <ThermostatMode>short</ThermostatMode>
            <ThermostatFanMode>short</ThermostatFanMode>
            <HeatSetPoint>short</HeatSetPoint>
            <CoolSetPoint>short</CoolSetPoint>
            <EnergySaveHeatSetPoint>short</EnergySaveHeatSetPoint>
            <EnergySaveCoolSetPoint>short</EnergySaveCoolSetPoint>
            <TemperatureScale>string</TemperatureScale>
            <CurrentTemperture>short</CurrentTemperture>
            <BatteryState>short</BatteryState>
            <FanModeList xsi:nil="true" />
            <ThermostatModeList xsi:nil="true" />
            <ThermostatSupportedOpModeList xsi:nil="true" />
            <DeviceStatusID>unsignedByte</DeviceStatusID>
            <LyricUserID>int</LyricUserID>
            <DeviceType>int</DeviceType>
            <AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
            <TccThermostat xsi:nil="true" />
            <LyricThermostat xsi:nil="true" />
          </MultiFamliyThermostatInfo>
          <MultiFamliyThermostatInfo>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceID>long</DeviceID>
            <ThermostatID>long</ThermostatID>
            <ThermostatName>string</ThermostatName>
            <ThermostatIndex>short</ThermostatIndex>
            <CurrentOpMode>short</CurrentOpMode>
            <ThermostatMode>short</ThermostatMode>
            <ThermostatFanMode>short</ThermostatFanMode>
            <HeatSetPoint>short</HeatSetPoint>
            <CoolSetPoint>short</CoolSetPoint>
            <EnergySaveHeatSetPoint>short</EnergySaveHeatSetPoint>
            <EnergySaveCoolSetPoint>short</EnergySaveCoolSetPoint>
            <TemperatureScale>string</TemperatureScale>
            <CurrentTemperture>short</CurrentTemperture>
            <BatteryState>short</BatteryState>
            <FanModeList xsi:nil="true" />
            <ThermostatModeList xsi:nil="true" />
            <ThermostatSupportedOpModeList xsi:nil="true" />
            <DeviceStatusID>unsignedByte</DeviceStatusID>
            <LyricUserID>int</LyricUserID>
            <DeviceType>int</DeviceType>
            <AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
            <TccThermostat xsi:nil="true" />
            <LyricThermostat xsi:nil="true" />
          </MultiFamliyThermostatInfo>
        </Thermostats>
      </listMultiFamliyThermostatInfo>
    </ControlMultiFamilyThermostat>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ControlMultiFamilyThermostatResponse xmlns="https://services.alarmnet.com/TC2/">
      <ControlMultiFamilyThermostatResult />
    </ControlMultiFamilyThermostatResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ControlMultiFamilyThermostat xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <listMultiFamliyThermostatInfo>
        <Thermostats>
          <MultiFamliyThermostatInfo>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceID>long</DeviceID>
            <ThermostatID>long</ThermostatID>
            <ThermostatName>string</ThermostatName>
            <ThermostatIndex>short</ThermostatIndex>
            <CurrentOpMode>short</CurrentOpMode>
            <ThermostatMode>short</ThermostatMode>
            <ThermostatFanMode>short</ThermostatFanMode>
            <HeatSetPoint>short</HeatSetPoint>
            <CoolSetPoint>short</CoolSetPoint>
            <EnergySaveHeatSetPoint>short</EnergySaveHeatSetPoint>
            <EnergySaveCoolSetPoint>short</EnergySaveCoolSetPoint>
            <TemperatureScale>string</TemperatureScale>
            <CurrentTemperture>short</CurrentTemperture>
            <BatteryState>short</BatteryState>
            <FanModeList xsi:nil="true" />
            <ThermostatModeList xsi:nil="true" />
            <ThermostatSupportedOpModeList xsi:nil="true" />
            <DeviceStatusID>unsignedByte</DeviceStatusID>
            <LyricUserID>int</LyricUserID>
            <DeviceType>int</DeviceType>
            <AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
            <TccThermostat xsi:nil="true" />
            <LyricThermostat xsi:nil="true" />
          </MultiFamliyThermostatInfo>
          <MultiFamliyThermostatInfo>
            <LocationID>long</LocationID>
            <LocationName>string</LocationName>
            <DeviceID>long</DeviceID>
            <ThermostatID>long</ThermostatID>
            <ThermostatName>string</ThermostatName>
            <ThermostatIndex>short</ThermostatIndex>
            <CurrentOpMode>short</CurrentOpMode>
            <ThermostatMode>short</ThermostatMode>
            <ThermostatFanMode>short</ThermostatFanMode>
            <HeatSetPoint>short</HeatSetPoint>
            <CoolSetPoint>short</CoolSetPoint>
            <EnergySaveHeatSetPoint>short</EnergySaveHeatSetPoint>
            <EnergySaveCoolSetPoint>short</EnergySaveCoolSetPoint>
            <TemperatureScale>string</TemperatureScale>
            <CurrentTemperture>short</CurrentTemperture>
            <BatteryState>short</BatteryState>
            <FanModeList xsi:nil="true" />
            <ThermostatModeList xsi:nil="true" />
            <ThermostatSupportedOpModeList xsi:nil="true" />
            <DeviceStatusID>unsignedByte</DeviceStatusID>
            <LyricUserID>int</LyricUserID>
            <DeviceType>int</DeviceType>
            <AutoChangeOverEnabled>boolean</AutoChangeOverEnabled>
            <TccThermostat xsi:nil="true" />
            <LyricThermostat xsi:nil="true" />
          </MultiFamliyThermostatInfo>
        </Thermostats>
      </listMultiFamliyThermostatInfo>
    </ControlMultiFamilyThermostat>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ControlMultiFamilyThermostatResponse xmlns="https://services.alarmnet.com/TC2/">
      <ControlMultiFamilyThermostatResult />
    </ControlMultiFamilyThermostatResponse>
  </soap12:Body>
</soap12:Envelope>