GET api/v1/locations/{locationId}/garageDoors

Get the list of garage door devices

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required

Body Parameters

None.

Response Information

Resource Description

WiFiGarageDoorResults

Name	Type	Additional information
Wifigaragedoors	WifiGarageDoors	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Wifigaragedoors": {
    "garageDoors": [
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "state": "sample string 3",
        "state_time": 4,
        "can_remote_close": "sample string 5",
        "gateway_id": "sample string 6",
        "online": true,
        "online_time": 8,
        "battery_low": true,
        "switchConfiguration": {
          "SwitchID": 1,
          "SwitchConfigState": 2,
          "IsWHEnabled": true
        }
      },
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "state": "sample string 3",
        "state_time": 4,
        "can_remote_close": "sample string 5",
        "gateway_id": "sample string 6",
        "online": true,
        "online_time": 8,
        "battery_low": true,
        "switchConfiguration": {
          "SwitchID": 1,
          "SwitchConfigState": 2,
          "IsWHEnabled": true
        }
      }
    ],
    "gateways": [
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "gdos": [
          "sample string 1",
          "sample string 2"
        ],
        "lights": [
          "sample string 1",
          "sample string 2"
        ],
        "gates": [
          "sample string 1",
          "sample string 2"
        ],
        "online": true,
        "online_time": 4
      },
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "gdos": [
          "sample string 1",
          "sample string 2"
        ],
        "lights": [
          "sample string 1",
          "sample string 2"
        ],
        "gates": [
          "sample string 1",
          "sample string 2"
        ],
        "online": true,
        "online_time": 4
      }
    ]
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<WiFiGarageDoorResults 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>
  <Wifigaragedoors xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
    <d2p1:garageDoors>
      <d2p1:WifiGarageDoorInfo>
        <d2p1:battery_low>true</d2p1:battery_low>
        <d2p1:can_remote_close>sample string 5</d2p1:can_remote_close>
        <d2p1:gateway_id>sample string 6</d2p1:gateway_id>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:name>sample string 2</d2p1:name>
        <d2p1:online>true</d2p1:online>
        <d2p1:online_time>8</d2p1:online_time>
        <d2p1:state>sample string 3</d2p1:state>
        <d2p1:state_time>4</d2p1:state_time>
        <d2p1:switchConfiguration>
          <d2p1:IsWHEnabled>true</d2p1:IsWHEnabled>
          <d2p1:SwitchConfigState>2</d2p1:SwitchConfigState>
          <d2p1:SwitchID>1</d2p1:SwitchID>
        </d2p1:switchConfiguration>
      </d2p1:WifiGarageDoorInfo>
      <d2p1:WifiGarageDoorInfo>
        <d2p1:battery_low>true</d2p1:battery_low>
        <d2p1:can_remote_close>sample string 5</d2p1:can_remote_close>
        <d2p1:gateway_id>sample string 6</d2p1:gateway_id>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:name>sample string 2</d2p1:name>
        <d2p1:online>true</d2p1:online>
        <d2p1:online_time>8</d2p1:online_time>
        <d2p1:state>sample string 3</d2p1:state>
        <d2p1:state_time>4</d2p1:state_time>
        <d2p1:switchConfiguration>
          <d2p1:IsWHEnabled>true</d2p1:IsWHEnabled>
          <d2p1:SwitchConfigState>2</d2p1:SwitchConfigState>
          <d2p1:SwitchID>1</d2p1:SwitchID>
        </d2p1:switchConfiguration>
      </d2p1:WifiGarageDoorInfo>
    </d2p1:garageDoors>
    <d2p1:gateways>
      <d2p1:GatewayInfos>
        <d2p1:gates xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:gates>
        <d2p1:gdos xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:gdos>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:lights xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:lights>
        <d2p1:name>sample string 2</d2p1:name>
        <d2p1:online>true</d2p1:online>
        <d2p1:online_time>4</d2p1:online_time>
      </d2p1:GatewayInfos>
      <d2p1:GatewayInfos>
        <d2p1:gates xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:gates>
        <d2p1:gdos xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:gdos>
        <d2p1:id>sample string 1</d2p1:id>
        <d2p1:lights xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:lights>
        <d2p1:name>sample string 2</d2p1:name>
        <d2p1:online>true</d2p1:online>
        <d2p1:online_time>4</d2p1:online_time>
      </d2p1:GatewayInfos>
    </d2p1:gateways>
  </Wifigaragedoors>
</WiFiGarageDoorResults>