GET api/v1/wifi/location/{locationId}?TCCUsername={TCCUsername}&TCCPassword={TCCPassword}&PartnerID={PartnerID}

Return a list of TCC WiFi locations and devices. Equivalent SOAP API : GetWiFiThermostatLocations

Request Information

URI Parameters

Name	Type	Additional information
locationId	integer	Required
TCCUsername	string	Default value is
TCCPassword	string	Default value is
PartnerID	string	Default value is

Body Parameters

None.

Response Information

Resource Description

TCCWiFiLocationsResults

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

Response Formats

application/json, text/json

Sample:

{
  "WiFiLocations": [
    {
      "TCCLocationID": 1,
      "LocationName": "sample string 2",
      "Devices": [
        {
          "TCCDeviceID": 1,
          "DeviceName": "sample string 3",
          "ThermostatConfiguration": {
            "ThermostatID": 1,
            "ThermostatConfigState": 2
          },
          "ThermostatLocationName": "sample string 4",
          "ThermostatSerialNo": "sample string 5"
        },
        {
          "TCCDeviceID": 1,
          "DeviceName": "sample string 3",
          "ThermostatConfiguration": {
            "ThermostatID": 1,
            "ThermostatConfigState": 2
          },
          "ThermostatLocationName": "sample string 4",
          "ThermostatSerialNo": "sample string 5"
        }
      ]
    },
    {
      "TCCLocationID": 1,
      "LocationName": "sample string 2",
      "Devices": [
        {
          "TCCDeviceID": 1,
          "DeviceName": "sample string 3",
          "ThermostatConfiguration": {
            "ThermostatID": 1,
            "ThermostatConfigState": 2
          },
          "ThermostatLocationName": "sample string 4",
          "ThermostatSerialNo": "sample string 5"
        },
        {
          "TCCDeviceID": 1,
          "DeviceName": "sample string 3",
          "ThermostatConfiguration": {
            "ThermostatID": 1,
            "ThermostatConfigState": 2
          },
          "ThermostatLocationName": "sample string 4",
          "ThermostatSerialNo": "sample string 5"
        }
      ]
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<TCCWiFiLocationsResults 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:TCCWiFiLocationInfo>
      <d2p1:Devices>
        <d2p1:TCCWiFiDeviceInfo>
          <d2p1:DeviceName>sample string 3</d2p1:DeviceName>
          <d2p1:TCCDeviceID>1</d2p1:TCCDeviceID>
          <d2p1:TCCLocationID>2</d2p1:TCCLocationID>
          <d2p1:ThermostatConfiguration>
            <d2p1:ThermostatConfigState>2</d2p1:ThermostatConfigState>
            <d2p1:ThermostatID>1</d2p1:ThermostatID>
          </d2p1:ThermostatConfiguration>
          <d2p1:ThermostatLocationName>sample string 4</d2p1:ThermostatLocationName>
          <d2p1:ThermostatSerialNo>sample string 5</d2p1:ThermostatSerialNo>
        </d2p1:TCCWiFiDeviceInfo>
        <d2p1:TCCWiFiDeviceInfo>
          <d2p1:DeviceName>sample string 3</d2p1:DeviceName>
          <d2p1:TCCDeviceID>1</d2p1:TCCDeviceID>
          <d2p1:TCCLocationID>2</d2p1:TCCLocationID>
          <d2p1:ThermostatConfiguration>
            <d2p1:ThermostatConfigState>2</d2p1:ThermostatConfigState>
            <d2p1:ThermostatID>1</d2p1:ThermostatID>
          </d2p1:ThermostatConfiguration>
          <d2p1:ThermostatLocationName>sample string 4</d2p1:ThermostatLocationName>
          <d2p1:ThermostatSerialNo>sample string 5</d2p1:ThermostatSerialNo>
        </d2p1:TCCWiFiDeviceInfo>
      </d2p1:Devices>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:TCCLocationID>1</d2p1:TCCLocationID>
    </d2p1:TCCWiFiLocationInfo>
    <d2p1:TCCWiFiLocationInfo>
      <d2p1:Devices>
        <d2p1:TCCWiFiDeviceInfo>
          <d2p1:DeviceName>sample string 3</d2p1:DeviceName>
          <d2p1:TCCDeviceID>1</d2p1:TCCDeviceID>
          <d2p1:TCCLocationID>2</d2p1:TCCLocationID>
          <d2p1:ThermostatConfiguration>
            <d2p1:ThermostatConfigState>2</d2p1:ThermostatConfigState>
            <d2p1:ThermostatID>1</d2p1:ThermostatID>
          </d2p1:ThermostatConfiguration>
          <d2p1:ThermostatLocationName>sample string 4</d2p1:ThermostatLocationName>
          <d2p1:ThermostatSerialNo>sample string 5</d2p1:ThermostatSerialNo>
        </d2p1:TCCWiFiDeviceInfo>
        <d2p1:TCCWiFiDeviceInfo>
          <d2p1:DeviceName>sample string 3</d2p1:DeviceName>
          <d2p1:TCCDeviceID>1</d2p1:TCCDeviceID>
          <d2p1:TCCLocationID>2</d2p1:TCCLocationID>
          <d2p1:ThermostatConfiguration>
            <d2p1:ThermostatConfigState>2</d2p1:ThermostatConfigState>
            <d2p1:ThermostatID>1</d2p1:ThermostatID>
          </d2p1:ThermostatConfiguration>
          <d2p1:ThermostatLocationName>sample string 4</d2p1:ThermostatLocationName>
          <d2p1:ThermostatSerialNo>sample string 5</d2p1:ThermostatSerialNo>
        </d2p1:TCCWiFiDeviceInfo>
      </d2p1:Devices>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:TCCLocationID>1</d2p1:TCCLocationID>
    </d2p1:TCCWiFiLocationInfo>
  </WiFiLocations>
</TCCWiFiLocationsResults>