GET api/v1/wifi/wifiLock/location/{locationId}

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

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required

Body Parameters

None.

Response Information

Resource Description

WiFiLockLocationsResults

Name	Type	Additional information
WiFiLocations	Collection of WiFiLockLocationInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "WiFiLocations": [
    {
      "LocationID": "sample string 1",
      "LocationName": "sample string 2",
      "WifiLocks": [
        {
          "LockID": "sample string 1",
          "LockName": "sample string 2",
          "LockStatus": "sample string 3",
          "LockConfiguration": {
            "LockID": 1,
            "LockConfigState": 2
          }
        },
        {
          "LockID": "sample string 1",
          "LockName": "sample string 2",
          "LockStatus": "sample string 3",
          "LockConfiguration": {
            "LockID": 1,
            "LockConfigState": 2
          }
        }
      ]
    },
    {
      "LocationID": "sample string 1",
      "LocationName": "sample string 2",
      "WifiLocks": [
        {
          "LockID": "sample string 1",
          "LockName": "sample string 2",
          "LockStatus": "sample string 3",
          "LockConfiguration": {
            "LockID": 1,
            "LockConfigState": 2
          }
        },
        {
          "LockID": "sample string 1",
          "LockName": "sample string 2",
          "LockStatus": "sample string 3",
          "LockConfiguration": {
            "LockID": 1,
            "LockConfigState": 2
          }
        }
      ]
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<WiFiLockLocationsResults 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>
  <WiFiLocations xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
    <d2p1:WiFiLockLocationInfo>
      <d2p1:LocationID>sample string 1</d2p1:LocationID>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:WifiLocks>
        <d2p1:WiFiLockInfo>
          <d2p1:LockConfiguration>
            <d2p1:IsWHEnabled>true</d2p1:IsWHEnabled>
            <d2p1:LockConfigState>2</d2p1:LockConfigState>
            <d2p1:LockID>1</d2p1:LockID>
          </d2p1:LockConfiguration>
          <d2p1:LockID>sample string 1</d2p1:LockID>
          <d2p1:LockName>sample string 2</d2p1:LockName>
          <d2p1:LockStatus>sample string 3</d2p1:LockStatus>
        </d2p1:WiFiLockInfo>
        <d2p1:WiFiLockInfo>
          <d2p1:LockConfiguration>
            <d2p1:IsWHEnabled>true</d2p1:IsWHEnabled>
            <d2p1:LockConfigState>2</d2p1:LockConfigState>
            <d2p1:LockID>1</d2p1:LockID>
          </d2p1:LockConfiguration>
          <d2p1:LockID>sample string 1</d2p1:LockID>
          <d2p1:LockName>sample string 2</d2p1:LockName>
          <d2p1:LockStatus>sample string 3</d2p1:LockStatus>
        </d2p1:WiFiLockInfo>
      </d2p1:WifiLocks>
    </d2p1:WiFiLockLocationInfo>
    <d2p1:WiFiLockLocationInfo>
      <d2p1:LocationID>sample string 1</d2p1:LocationID>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:WifiLocks>
        <d2p1:WiFiLockInfo>
          <d2p1:LockConfiguration>
            <d2p1:IsWHEnabled>true</d2p1:IsWHEnabled>
            <d2p1:LockConfigState>2</d2p1:LockConfigState>
            <d2p1:LockID>1</d2p1:LockID>
          </d2p1:LockConfiguration>
          <d2p1:LockID>sample string 1</d2p1:LockID>
          <d2p1:LockName>sample string 2</d2p1:LockName>
          <d2p1:LockStatus>sample string 3</d2p1:LockStatus>
        </d2p1:WiFiLockInfo>
        <d2p1:WiFiLockInfo>
          <d2p1:LockConfiguration>
            <d2p1:IsWHEnabled>true</d2p1:IsWHEnabled>
            <d2p1:LockConfigState>2</d2p1:LockConfigState>
            <d2p1:LockID>1</d2p1:LockID>
          </d2p1:LockConfiguration>
          <d2p1:LockID>sample string 1</d2p1:LockID>
          <d2p1:LockName>sample string 2</d2p1:LockName>
          <d2p1:LockStatus>sample string 3</d2p1:LockStatus>
        </d2p1:WiFiLockInfo>
      </d2p1:WifiLocks>
    </d2p1:WiFiLockLocationInfo>
  </WiFiLocations>
</WiFiLockLocationsResults>