svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

AddRemoveLyricThermostat

Activate and Remove Lyric Thermostat in Total Connect.

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/AddRemoveLyricThermostat"

<?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>
    <AddRemoveLyricThermostat xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>int</LocationID>
      <LyricUsername>string</LyricUsername>
      <LyricPassword>string</LyricPassword>
      <lyricLocationID>int</lyricLocationID>
      <lyricThermostatDeviceInfo>
        <LyricThermostatDeviceInfo>
          <LyricDeviceID>string</LyricDeviceID>
          <DeviceName>string</DeviceName>
          <LyricDevicetype>int</LyricDevicetype>
          <DeviceClass>string</DeviceClass>
          <IsAlive>boolean</IsAlive>
          <isProvisioned>boolean</isProvisioned>
          <isUpgrading>boolean</isUpgrading>
          <ThermostatConfiguration>
            <ThermostatID>long</ThermostatID>
            <ThermostatConfigState>int</ThermostatConfigState>
          </ThermostatConfiguration>
        </LyricThermostatDeviceInfo>
        <LyricThermostatDeviceInfo>
          <LyricDeviceID>string</LyricDeviceID>
          <DeviceName>string</DeviceName>
          <LyricDevicetype>int</LyricDevicetype>
          <DeviceClass>string</DeviceClass>
          <IsAlive>boolean</IsAlive>
          <isProvisioned>boolean</isProvisioned>
          <isUpgrading>boolean</isUpgrading>
          <ThermostatConfiguration>
            <ThermostatID>long</ThermostatID>
            <ThermostatConfigState>int</ThermostatConfigState>
          </ThermostatConfiguration>
        </LyricThermostatDeviceInfo>
      </lyricThermostatDeviceInfo>
    </AddRemoveLyricThermostat>
  </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>
    <AddRemoveLyricThermostatResponse xmlns="https://services.alarmnet.com/TC2/">
      <AddRemoveLyricThermostatResult>
        <ResultCode>int</ResultCode>
        <ResultData>string</ResultData>
      </AddRemoveLyricThermostatResult>
    </AddRemoveLyricThermostatResponse>
  </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>
    <AddRemoveLyricThermostat xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>int</LocationID>
      <LyricUsername>string</LyricUsername>
      <LyricPassword>string</LyricPassword>
      <lyricLocationID>int</lyricLocationID>
      <lyricThermostatDeviceInfo>
        <LyricThermostatDeviceInfo>
          <LyricDeviceID>string</LyricDeviceID>
          <DeviceName>string</DeviceName>
          <LyricDevicetype>int</LyricDevicetype>
          <DeviceClass>string</DeviceClass>
          <IsAlive>boolean</IsAlive>
          <isProvisioned>boolean</isProvisioned>
          <isUpgrading>boolean</isUpgrading>
          <ThermostatConfiguration>
            <ThermostatID>long</ThermostatID>
            <ThermostatConfigState>int</ThermostatConfigState>
          </ThermostatConfiguration>
        </LyricThermostatDeviceInfo>
        <LyricThermostatDeviceInfo>
          <LyricDeviceID>string</LyricDeviceID>
          <DeviceName>string</DeviceName>
          <LyricDevicetype>int</LyricDevicetype>
          <DeviceClass>string</DeviceClass>
          <IsAlive>boolean</IsAlive>
          <isProvisioned>boolean</isProvisioned>
          <isUpgrading>boolean</isUpgrading>
          <ThermostatConfiguration>
            <ThermostatID>long</ThermostatID>
            <ThermostatConfigState>int</ThermostatConfigState>
          </ThermostatConfiguration>
        </LyricThermostatDeviceInfo>
      </lyricThermostatDeviceInfo>
    </AddRemoveLyricThermostat>
  </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>
    <AddRemoveLyricThermostatResponse xmlns="https://services.alarmnet.com/TC2/">
      <AddRemoveLyricThermostatResult>
        <ResultCode>int</ResultCode>
        <ResultData>string</ResultData>
      </AddRemoveLyricThermostatResult>
    </AddRemoveLyricThermostatResponse>
  </soap12:Body>
</soap12:Envelope>