POST api/v1/wifi/api/partners/login

Return a list of Lyric locations and devices. Equivalent SOAP API : GetLyricLocations

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LocationId	integer	Required
PartnerName	string	Required
DeviceType	string	None.
CustomInfo	CustomInfo	Required

Request Formats

application/json, text/json

Sample:

{
  "LocationId": 1,
  "PartnerName": "sample string 2",
  "DeviceType": "sample string 3",
  "CustomInfo": {
    "Username": "sample string 1",
    "Password": "sample string 2",
    "IsEncrypted": true
  }
}

application/xml, text/xml

Sample:

<LyricLogin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
  <CustomInfo>
    <IsEncrypted>true</IsEncrypted>
    <Password>sample string 2</Password>
    <Username>sample string 1</Username>
  </CustomInfo>
  <DeviceType>sample string 3</DeviceType>
  <LocationId>1</LocationId>
  <PartnerName>sample string 2</PartnerName>
</LyricLogin>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LyricThermostatLocationsResults

Name	Type	Additional information
LyricLocations	Collection of LyricThermostatLocationInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "LyricLocations": [
    {
      "LyricLocationID": 1,
      "LocationName": "sample string 2",
      "Devices": [
        {
          "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
          }
        }
      ]
    },
    {
      "LyricLocationID": 1,
      "LocationName": "sample string 2",
      "Devices": [
        {
          "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
          }
        }
      ]
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<LyricThermostatLocationsResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <LyricLocations xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
    <d2p1:LyricThermostatLocationInfo>
      <d2p1:Devices>
        <d2p1:LyricThermostatDeviceInfo>
          <d2p1:DeviceClass>sample string 5</d2p1:DeviceClass>
          <d2p1:DeviceName>sample string 3</d2p1:DeviceName>
          <d2p1:IsAlive>true</d2p1:IsAlive>
          <d2p1:LyricDeviceID>sample string 1</d2p1:LyricDeviceID>
          <d2p1:LyricDevicetype>4</d2p1:LyricDevicetype>
          <d2p1:LyricLocationID>2</d2p1:LyricLocationID>
          <d2p1:ThermostatConfiguration>
            <d2p1:ThermostatConfigState>2</d2p1:ThermostatConfigState>
            <d2p1:ThermostatID>1</d2p1:ThermostatID>
          </d2p1:ThermostatConfiguration>
          <d2p1:isProvisioned>true</d2p1:isProvisioned>
          <d2p1:isUpgrading>true</d2p1:isUpgrading>
        </d2p1:LyricThermostatDeviceInfo>
        <d2p1:LyricThermostatDeviceInfo>
          <d2p1:DeviceClass>sample string 5</d2p1:DeviceClass>
          <d2p1:DeviceName>sample string 3</d2p1:DeviceName>
          <d2p1:IsAlive>true</d2p1:IsAlive>
          <d2p1:LyricDeviceID>sample string 1</d2p1:LyricDeviceID>
          <d2p1:LyricDevicetype>4</d2p1:LyricDevicetype>
          <d2p1:LyricLocationID>2</d2p1:LyricLocationID>
          <d2p1:ThermostatConfiguration>
            <d2p1:ThermostatConfigState>2</d2p1:ThermostatConfigState>
            <d2p1:ThermostatID>1</d2p1:ThermostatID>
          </d2p1:ThermostatConfiguration>
          <d2p1:isProvisioned>true</d2p1:isProvisioned>
          <d2p1:isUpgrading>true</d2p1:isUpgrading>
        </d2p1:LyricThermostatDeviceInfo>
      </d2p1:Devices>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:LyricLocationID>1</d2p1:LyricLocationID>
    </d2p1:LyricThermostatLocationInfo>
    <d2p1:LyricThermostatLocationInfo>
      <d2p1:Devices>
        <d2p1:LyricThermostatDeviceInfo>
          <d2p1:DeviceClass>sample string 5</d2p1:DeviceClass>
          <d2p1:DeviceName>sample string 3</d2p1:DeviceName>
          <d2p1:IsAlive>true</d2p1:IsAlive>
          <d2p1:LyricDeviceID>sample string 1</d2p1:LyricDeviceID>
          <d2p1:LyricDevicetype>4</d2p1:LyricDevicetype>
          <d2p1:LyricLocationID>2</d2p1:LyricLocationID>
          <d2p1:ThermostatConfiguration>
            <d2p1:ThermostatConfigState>2</d2p1:ThermostatConfigState>
            <d2p1:ThermostatID>1</d2p1:ThermostatID>
          </d2p1:ThermostatConfiguration>
          <d2p1:isProvisioned>true</d2p1:isProvisioned>
          <d2p1:isUpgrading>true</d2p1:isUpgrading>
        </d2p1:LyricThermostatDeviceInfo>
        <d2p1:LyricThermostatDeviceInfo>
          <d2p1:DeviceClass>sample string 5</d2p1:DeviceClass>
          <d2p1:DeviceName>sample string 3</d2p1:DeviceName>
          <d2p1:IsAlive>true</d2p1:IsAlive>
          <d2p1:LyricDeviceID>sample string 1</d2p1:LyricDeviceID>
          <d2p1:LyricDevicetype>4</d2p1:LyricDevicetype>
          <d2p1:LyricLocationID>2</d2p1:LyricLocationID>
          <d2p1:ThermostatConfiguration>
            <d2p1:ThermostatConfigState>2</d2p1:ThermostatConfigState>
            <d2p1:ThermostatID>1</d2p1:ThermostatID>
          </d2p1:ThermostatConfiguration>
          <d2p1:isProvisioned>true</d2p1:isProvisioned>
          <d2p1:isUpgrading>true</d2p1:isUpgrading>
        </d2p1:LyricThermostatDeviceInfo>
      </d2p1:Devices>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:LyricLocationID>1</d2p1:LyricLocationID>
    </d2p1:LyricThermostatLocationInfo>
  </LyricLocations>
</LyricThermostatLocationsResults>