POST api/v1/locations/{locationId}/devices/{deviceId}/automation/switches
On/Off - Specific or Multiple switchs.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| deviceId |
Device ID |
integer |
Required |
| locationId | string |
None. |
Body Parameters
Model of SwitchAction
SwitchAction| Name | Description | Type | Additional information |
|---|---|---|---|
| ids | Collection of integer |
None. |
|
| level | integer |
None. |
|
| action | eSwitchAction |
None. |
Request Formats
application/json, text/json
Sample:
{
"action": 0,
"ids": [
1,
2
],
"level": 1
}
application/xml, text/xml
Sample:
<SwitchAction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
<action>off</action>
<ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:long>1</d2p1:long>
<d2p1:long>2</d2p1:long>
</ids>
<level>1</level>
</SwitchAction>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ListAutomationDeviceResults| Name | Description | Type | Additional information |
|---|---|---|---|
| AutomationDevices | Collection of AutomationDeviceResults |
None. |
Response Formats
application/json, text/json
Sample:
{
"AutomationDevices": [
{
"Id": 1,
"ResultCode": 2,
"ResultData": "sample string 3"
},
{
"Id": 1,
"ResultCode": 2,
"ResultData": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<ListAutomationDeviceResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
<AutomationDevices>
<AutomationDeviceResults>
<ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">2</ResultCode>
<ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
<Id>1</Id>
</AutomationDeviceResults>
<AutomationDeviceResults>
<ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">2</ResultCode>
<ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 3</ResultData>
<Id>1</Id>
</AutomationDeviceResults>
</AutomationDevices>
</ListAutomationDeviceResults>