svcTC2API


Click here for a complete list of operations.

GetLyricLocations

Return a list of Lyric locations and devices.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
LocationID:
LyricUsername:
LyricPassword:

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

<?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>
    <GetLyricLocations xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <LyricUsername>string</LyricUsername>
      <LyricPassword>string</LyricPassword>
    </GetLyricLocations>
  </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>
    <GetLyricLocationsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetLyricLocationsResult>
        <LyricLocations>
          <LyricThermostatLocationInfo>
            <LyricLocationID>int</LyricLocationID>
            <LocationName>string</LocationName>
            <Devices xsi:nil="true" />
          </LyricThermostatLocationInfo>
          <LyricThermostatLocationInfo>
            <LyricLocationID>int</LyricLocationID>
            <LocationName>string</LocationName>
            <Devices xsi:nil="true" />
          </LyricThermostatLocationInfo>
        </LyricLocations>
      </GetLyricLocationsResult>
    </GetLyricLocationsResponse>
  </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>
    <GetLyricLocations xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <LyricUsername>string</LyricUsername>
      <LyricPassword>string</LyricPassword>
    </GetLyricLocations>
  </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>
    <GetLyricLocationsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetLyricLocationsResult>
        <LyricLocations>
          <LyricThermostatLocationInfo>
            <LyricLocationID>int</LyricLocationID>
            <LocationName>string</LocationName>
            <Devices xsi:nil="true" />
          </LyricThermostatLocationInfo>
          <LyricThermostatLocationInfo>
            <LyricLocationID>int</LyricLocationID>
            <LocationName>string</LocationName>
            <Devices xsi:nil="true" />
          </LyricThermostatLocationInfo>
        </LyricLocations>
      </GetLyricLocationsResult>
    </GetLyricLocationsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /TC21API/TC2.asmx/GetLyricLocations?SessionID=string&LocationID=string&LyricUsername=string&LyricPassword=string HTTP/1.1
Host: rs.alarmnet.com

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

<?xml version="1.0" encoding="utf-8"?>
<LyricThermostatLocationsResults xmlns="https://services.alarmnet.com/TC2/">
  <LyricLocations>
    <LyricThermostatLocationInfo>
      <LyricLocationID>int</LyricLocationID>
      <LocationName>string</LocationName>
      <Devices>
        <LyricThermostatDeviceInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LyricThermostatDeviceInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Devices>
    </LyricThermostatLocationInfo>
    <LyricThermostatLocationInfo>
      <LyricLocationID>int</LyricLocationID>
      <LocationName>string</LocationName>
      <Devices>
        <LyricThermostatDeviceInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LyricThermostatDeviceInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Devices>
    </LyricThermostatLocationInfo>
  </LyricLocations>
</LyricThermostatLocationsResults>

HTTP POST

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

POST /TC21API/TC2.asmx/GetLyricLocations HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&LocationID=string&LyricUsername=string&LyricPassword=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<LyricThermostatLocationsResults xmlns="https://services.alarmnet.com/TC2/">
  <LyricLocations>
    <LyricThermostatLocationInfo>
      <LyricLocationID>int</LyricLocationID>
      <LocationName>string</LocationName>
      <Devices>
        <LyricThermostatDeviceInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LyricThermostatDeviceInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Devices>
    </LyricThermostatLocationInfo>
    <LyricThermostatLocationInfo>
      <LyricLocationID>int</LyricLocationID>
      <LocationName>string</LocationName>
      <Devices>
        <LyricThermostatDeviceInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LyricThermostatDeviceInfo d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Devices>
    </LyricThermostatLocationInfo>
  </LyricLocations>
</LyricThermostatLocationsResults>