GET api/v1/locations/{locationId}/partitions/sensorsMaskStatus
Get the list of notification states permitted for this location.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationId |
Location ID |
integer |
Required |
| PartitionIds | string |
None. |
Body Parameters
None.
Response Information
Resource Description
SensorEventResult| Name | Description | Type | Additional information |
|---|---|---|---|
| SensorMaskStatus | Collection of SensorMaskStatus |
None. |
|
| LocationLimitations | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"SensorMaskStatus": [
{
"ZoneID": 1,
"ZoneDescription": "sample string 2",
"MaskStatus": 3,
"NotificationCount": 4,
"VideoTriggerCount": 5,
"PartitionID": 6,
"MaskDisabled": true
},
{
"ZoneID": 1,
"ZoneDescription": "sample string 2",
"MaskStatus": 3,
"NotificationCount": 4,
"VideoTriggerCount": 5,
"PartitionID": 6,
"MaskDisabled": true
}
],
"LocationLimitations": "sample string 1"
}
application/xml, text/xml
Sample:
<SensorEventResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1">
<LocationLimitations>sample string 1</LocationLimitations>
<SensorMaskStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
<d2p1:SensorMaskStatus>
<d2p1:MaskDisabled>true</d2p1:MaskDisabled>
<d2p1:MaskStatus>3</d2p1:MaskStatus>
<d2p1:NotificationCount>4</d2p1:NotificationCount>
<d2p1:PartitionID>6</d2p1:PartitionID>
<d2p1:VideoTriggerCount>5</d2p1:VideoTriggerCount>
<d2p1:ZoneDescription>sample string 2</d2p1:ZoneDescription>
<d2p1:ZoneID>1</d2p1:ZoneID>
</d2p1:SensorMaskStatus>
<d2p1:SensorMaskStatus>
<d2p1:MaskDisabled>true</d2p1:MaskDisabled>
<d2p1:MaskStatus>3</d2p1:MaskStatus>
<d2p1:NotificationCount>4</d2p1:NotificationCount>
<d2p1:PartitionID>6</d2p1:PartitionID>
<d2p1:VideoTriggerCount>5</d2p1:VideoTriggerCount>
<d2p1:ZoneDescription>sample string 2</d2p1:ZoneDescription>
<d2p1:ZoneID>1</d2p1:ZoneID>
</d2p1:SensorMaskStatus>
</SensorMaskStatus>
</SensorEventResult>