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

Generate access token for chamberlain garage door

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId		integer	Required

Body Parameters

Collection of WifiGarageDoorInfo

Name	Type	Additional information
id	string	None.
name	string	None.
state	string	None.
state_time	integer	None.
can_remote_close	string	None.
gateway_id	string	None.
online	boolean	None.
online_time	integer	None.
battery_low	boolean	None.
switchConfiguration	WiFiSwitchConfigInfo	None.

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ArrayOfWifiGarageDoorInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain.Automation">
  <WifiGarageDoorInfo>
    <battery_low>true</battery_low>
    <can_remote_close>sample string 5</can_remote_close>
    <gateway_id>sample string 6</gateway_id>
    <id>sample string 1</id>
    <name>sample string 2</name>
    <online>true</online>
    <online_time>8</online_time>
    <state>sample string 3</state>
    <state_time>4</state_time>
    <switchConfiguration>
      <IsWHEnabled>true</IsWHEnabled>
      <SwitchConfigState>2</SwitchConfigState>
      <SwitchID>1</SwitchID>
    </switchConfiguration>
  </WifiGarageDoorInfo>
  <WifiGarageDoorInfo>
    <battery_low>true</battery_low>
    <can_remote_close>sample string 5</can_remote_close>
    <gateway_id>sample string 6</gateway_id>
    <id>sample string 1</id>
    <name>sample string 2</name>
    <online>true</online>
    <online_time>8</online_time>
    <state>sample string 3</state>
    <state_time>4</state_time>
    <switchConfiguration>
      <IsWHEnabled>true</IsWHEnabled>
      <SwitchConfigState>2</SwitchConfigState>
      <SwitchID>1</SwitchID>
    </switchConfiguration>
  </WifiGarageDoorInfo>
</ArrayOfWifiGarageDoorInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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>