POST api/v1/wifi/lyricThermostat/location/{locationId}/lyricLcations/{lyriclocationId}

Activate and Remove Lyric Thermostat in Total Connect. Equivalent SOAP API: AddRemoveLyricThermostat

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required
lyriclocationId		integer	Required

Body Parameters

Lyricinfo

Name	Type	Additional information
LyricThermostatDeviceInfo	Collection of LyricThermostatDeviceInfo	None.
Username	string	Required
Password	string	Required
IsEncrypted	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "LyricThermostatDeviceInfo": [
    {
      "LyricDeviceID": "sample string 1",
      "DeviceName": "sample string 3",
      "LyricDevicetype": 4,
      "DeviceClass": "sample string 5",
      "IsAlive": true,
      "isProvisioned": true,
      "isUpgrading": true,
      "ThermostatConfiguration": {
        "ThermostatID": 1,
        "ThermostatConfigState": 2
      }
    },
    {
      "LyricDeviceID": "sample string 1",
      "DeviceName": "sample string 3",
      "LyricDevicetype": 4,
      "DeviceClass": "sample string 5",
      "IsAlive": true,
      "isProvisioned": true,
      "isUpgrading": true,
      "ThermostatConfiguration": {
        "ThermostatID": 1,
        "ThermostatConfigState": 2
      }
    }
  ],
  "Username": "sample string 1",
  "Password": "sample string 2",
  "IsEncrypted": true
}

application/xml, text/xml

Sample:

<Lyricinfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
  <IsEncrypted>true</IsEncrypted>
  <LyricThermostatDeviceInfo>
    <LyricThermostatDeviceInfo>
      <DeviceClass>sample string 5</DeviceClass>
      <DeviceName>sample string 3</DeviceName>
      <IsAlive>true</IsAlive>
      <LyricDeviceID>sample string 1</LyricDeviceID>
      <LyricDevicetype>4</LyricDevicetype>
      <LyricLocationID>2</LyricLocationID>
      <ThermostatConfiguration>
        <ThermostatConfigState>2</ThermostatConfigState>
        <ThermostatID>1</ThermostatID>
      </ThermostatConfiguration>
      <isProvisioned>true</isProvisioned>
      <isUpgrading>true</isUpgrading>
    </LyricThermostatDeviceInfo>
    <LyricThermostatDeviceInfo>
      <DeviceClass>sample string 5</DeviceClass>
      <DeviceName>sample string 3</DeviceName>
      <IsAlive>true</IsAlive>
      <LyricDeviceID>sample string 1</LyricDeviceID>
      <LyricDevicetype>4</LyricDevicetype>
      <LyricLocationID>2</LyricLocationID>
      <ThermostatConfiguration>
        <ThermostatConfigState>2</ThermostatConfigState>
        <ThermostatID>1</ThermostatID>
      </ThermostatConfiguration>
      <isProvisioned>true</isProvisioned>
      <isUpgrading>true</isUpgrading>
    </LyricThermostatDeviceInfo>
  </LyricThermostatDeviceInfo>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</Lyricinfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WiFiLocationsResults

BaseResults

Name	Description	Type	Additional information
ResultCode		integer	None.
ResultData		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<BaseResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">
  <ResultCode>1</ResultCode>
  <ResultData>sample string 2</ResultData>
</BaseResults>