POST api/v1/locations/{locationId}/devices/{deviceId}/partitions/activate
To enable and configure feature for each partition by master user
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationId |
Location ID |
integer |
Required |
| deviceId |
Device ID |
integer |
Required |
Body Parameters
List of Partition Details
PartitionConfigInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
User ID |
integer |
None. |
| PartitionDetails |
List of partition settings |
Collection of PartitionSettingsInfo |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserId": 1,
"PartitionDetails": [
{
"PartitionName": "sample string 1",
"PartitionId": 2,
"IsFireEnabled": true,
"IsCommonEnabled": true,
"IsNightStayEnabled": 5,
"ExitDelayTimer": 6,
"IsInWalkTest": true
},
{
"PartitionName": "sample string 1",
"PartitionId": 2,
"IsFireEnabled": true,
"IsCommonEnabled": true,
"IsNightStayEnabled": 5,
"ExitDelayTimer": 6,
"IsInWalkTest": true
}
]
}
application/xml, text/xml
Sample:
<PartitionConfigInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Security">
<PartitionDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
<d2p1:PartitionSettingsInfo>
<d2p1:ExitDelayTimer>6</d2p1:ExitDelayTimer>
<d2p1:IsCommonEnabled>true</d2p1:IsCommonEnabled>
<d2p1:IsFireEnabled>true</d2p1:IsFireEnabled>
<d2p1:IsInWalkTest>true</d2p1:IsInWalkTest>
<d2p1:IsNightStayEnabled>5</d2p1:IsNightStayEnabled>
<d2p1:PartitionId>2</d2p1:PartitionId>
<d2p1:PartitionName>sample string 1</d2p1:PartitionName>
</d2p1:PartitionSettingsInfo>
<d2p1:PartitionSettingsInfo>
<d2p1:ExitDelayTimer>6</d2p1:ExitDelayTimer>
<d2p1:IsCommonEnabled>true</d2p1:IsCommonEnabled>
<d2p1:IsFireEnabled>true</d2p1:IsFireEnabled>
<d2p1:IsInWalkTest>true</d2p1:IsInWalkTest>
<d2p1:IsNightStayEnabled>5</d2p1:IsNightStayEnabled>
<d2p1:PartitionId>2</d2p1:PartitionId>
<d2p1:PartitionName>sample string 1</d2p1:PartitionName>
</d2p1:PartitionSettingsInfo>
</PartitionDetails>
<UserId>1</UserId>
</PartitionConfigInfo>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BaseResults
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>