POST api/v1/wifi/lyricThermostat/location/{locationId}/username/{LyricUsername}/pwd/{LyricPassword}/lyricLcations/{lyriclocationId}

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

Request Information

URI Parameters

Name	Type	Additional information
locationId	integer	Required
LyricUsername	string	Required
LyricPassword	string	Required
lyriclocationId	integer	Required

Body Parameters

Collection of LyricThermostatDeviceInfo

Name	Type	Additional information
LyricDeviceID	string	None.
DeviceName	string	None.
LyricDevicetype	integer	None.
DeviceClass	string	None.
IsAlive	boolean	None.
isProvisioned	boolean	None.
isUpgrading	boolean	None.
ThermostatConfiguration	LyricThermostatConfigInfo	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "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
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfLyricThermostatDeviceInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
  <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>
</ArrayOfLyricThermostatDeviceInfo>

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>