GET api/v1/locations/{locationId}/user/{userid}/SecurityStatus
Request for PanelMetadata and security status of each partition for the Given Location and User.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationId |
Location ID |
integer |
Required |
| userid |
UserId ID |
integer |
Required |
| LastSequenceNumber | integer |
None. |
|
| LastUpdatedTimestampTicks | integer |
None. |
|
| PartitionIds | string |
None. |
Body Parameters
None.
Response Information
Resource Description
LocationBasicInfo wiht partition security status
Collection of LocationBasicInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationID | integer |
None. |
|
| LocationName | string |
None. |
|
| ISOccupied | boolean |
None. |
|
| ResultData | string |
None. |
|
| PanelMetadataAndStatus | PanelMetadataAndStatusInfo |
None. |
|
| IsRental | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"LocationID": 1,
"LocationName": "sample string 2",
"ISOccupied": true,
"ResultData": "sample string 4",
"PanelMetadataAndStatus": {
"Zones": [
{
"ZoneID": 1,
"ZoneDescription": "sample string 2",
"MaskDisabled": true,
"ZoneStatus": 4,
"IsFaulted": false,
"IsTampered": false,
"IsLowBattery": false,
"IsInTrouble": false,
"IsBypassed": false,
"IsInAlarm": false,
"IsInACLoss": false,
"IsInObstructed": false,
"IsInSupervisionFailure": false,
"PartitionID": 5,
"BatteryLevel": 1,
"SignalStrength": 1
},
{
"ZoneID": 1,
"ZoneDescription": "sample string 2",
"MaskDisabled": true,
"ZoneStatus": 4,
"IsFaulted": false,
"IsTampered": false,
"IsLowBattery": false,
"IsInTrouble": false,
"IsBypassed": false,
"IsInAlarm": false,
"IsInACLoss": false,
"IsInObstructed": false,
"IsInSupervisionFailure": false,
"PartitionID": 5,
"BatteryLevel": 1,
"SignalStrength": 1
}
],
"PromptForImportSecuritySettings": true,
"DeviceSerialText": "sample string 2",
"LastUpdatedTimestampTicks": 3,
"ConfigurationSequenceNumber": 4,
"IsInACLoss": true,
"IsCoverTampered": true,
"Bell1SupervisionFailure": true,
"Bell2SupervisionFailure": true,
"IsInLowBattery": true,
"IsInEnrollmentMode": true,
"IsEntryDelayEnabled": true,
"PrevArmingState": 12,
"PanelType": "sample string 13",
"FirmwareVersion": "sample string 14",
"Partitions": [
{
"PartitionID": 1,
"PartitionArmingState": 2,
"ArmingState": 2,
"OverrideArmingState": 3,
"OverrideTimeStamp": "2025-10-28T10:11:52.1575746-04:00",
"IsAlarmResponded": true,
"AlarmTriggerTime": "2025-10-28T10:11:52.1575746-04:00",
"AlarmTriggerTimeLocalized": "2025-10-28T10:11:52.1585838-04:00"
},
{
"PartitionID": 1,
"PartitionArmingState": 2,
"ArmingState": 2,
"OverrideArmingState": 3,
"OverrideTimeStamp": "2025-10-28T10:11:52.1575746-04:00",
"IsAlarmResponded": true,
"AlarmTriggerTime": "2025-10-28T10:11:52.1575746-04:00",
"AlarmTriggerTimeLocalized": "2025-10-28T10:11:52.1585838-04:00"
}
]
},
"IsRental": true
},
{
"LocationID": 1,
"LocationName": "sample string 2",
"ISOccupied": true,
"ResultData": "sample string 4",
"PanelMetadataAndStatus": {
"Zones": [
{
"ZoneID": 1,
"ZoneDescription": "sample string 2",
"MaskDisabled": true,
"ZoneStatus": 4,
"IsFaulted": false,
"IsTampered": false,
"IsLowBattery": false,
"IsInTrouble": false,
"IsBypassed": false,
"IsInAlarm": false,
"IsInACLoss": false,
"IsInObstructed": false,
"IsInSupervisionFailure": false,
"PartitionID": 5,
"BatteryLevel": 1,
"SignalStrength": 1
},
{
"ZoneID": 1,
"ZoneDescription": "sample string 2",
"MaskDisabled": true,
"ZoneStatus": 4,
"IsFaulted": false,
"IsTampered": false,
"IsLowBattery": false,
"IsInTrouble": false,
"IsBypassed": false,
"IsInAlarm": false,
"IsInACLoss": false,
"IsInObstructed": false,
"IsInSupervisionFailure": false,
"PartitionID": 5,
"BatteryLevel": 1,
"SignalStrength": 1
}
],
"PromptForImportSecuritySettings": true,
"DeviceSerialText": "sample string 2",
"LastUpdatedTimestampTicks": 3,
"ConfigurationSequenceNumber": 4,
"IsInACLoss": true,
"IsCoverTampered": true,
"Bell1SupervisionFailure": true,
"Bell2SupervisionFailure": true,
"IsInLowBattery": true,
"IsInEnrollmentMode": true,
"IsEntryDelayEnabled": true,
"PrevArmingState": 12,
"PanelType": "sample string 13",
"FirmwareVersion": "sample string 14",
"Partitions": [
{
"PartitionID": 1,
"PartitionArmingState": 2,
"ArmingState": 2,
"OverrideArmingState": 3,
"OverrideTimeStamp": "2025-10-28T10:11:52.1575746-04:00",
"IsAlarmResponded": true,
"AlarmTriggerTime": "2025-10-28T10:11:52.1575746-04:00",
"AlarmTriggerTimeLocalized": "2025-10-28T10:11:52.1585838-04:00"
},
{
"PartitionID": 1,
"PartitionArmingState": 2,
"ArmingState": 2,
"OverrideArmingState": 3,
"OverrideTimeStamp": "2025-10-28T10:11:52.1575746-04:00",
"IsAlarmResponded": true,
"AlarmTriggerTime": "2025-10-28T10:11:52.1575746-04:00",
"AlarmTriggerTimeLocalized": "2025-10-28T10:11:52.1585838-04:00"
}
]
},
"IsRental": true
}
]
application/xml, text/xml
Sample:
<ArrayOfLocationBasicInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain">
<LocationBasicInfo>
<ISOccupied>true</ISOccupied>
<IsRental>true</IsRental>
<LocationID>1</LocationID>
<LocationName>sample string 2</LocationName>
<PanelMetadataAndStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
<d3p1:Bell1SupervisionFailure>true</d3p1:Bell1SupervisionFailure>
<d3p1:Bell2SupervisionFailure>true</d3p1:Bell2SupervisionFailure>
<d3p1:ConfigurationSequenceNumber>4</d3p1:ConfigurationSequenceNumber>
<d3p1:FirmwareVersion>sample string 14</d3p1:FirmwareVersion>
<d3p1:IsCoverTampered>true</d3p1:IsCoverTampered>
<d3p1:IsEntryDelayEnabled>true</d3p1:IsEntryDelayEnabled>
<d3p1:IsInACLoss>true</d3p1:IsInACLoss>
<d3p1:IsInEnrollmentMode>true</d3p1:IsInEnrollmentMode>
<d3p1:IsInLowBattery>true</d3p1:IsInLowBattery>
<d3p1:LastUpdatedTimestampTicks>3</d3p1:LastUpdatedTimestampTicks>
<d3p1:PanelType>sample string 13</d3p1:PanelType>
<d3p1:Partitions>
<d3p1:PartitionInfo>
<d3p1:AlarmTriggerTime>2025-10-28T10:11:52.1575746-04:00</d3p1:AlarmTriggerTime>
<d3p1:AlarmTriggerTimeLocalized>2025-10-28T10:11:52.1585838-04:00</d3p1:AlarmTriggerTimeLocalized>
<d3p1:ArmingState>2</d3p1:ArmingState>
<d3p1:IsAlarmResponded>true</d3p1:IsAlarmResponded>
<d3p1:OverrideArmingState>3</d3p1:OverrideArmingState>
<d3p1:OverrideTimeStamp>2025-10-28T10:11:52.1575746-04:00</d3p1:OverrideTimeStamp>
<d3p1:PartitionID>1</d3p1:PartitionID>
</d3p1:PartitionInfo>
<d3p1:PartitionInfo>
<d3p1:AlarmTriggerTime>2025-10-28T10:11:52.1575746-04:00</d3p1:AlarmTriggerTime>
<d3p1:AlarmTriggerTimeLocalized>2025-10-28T10:11:52.1585838-04:00</d3p1:AlarmTriggerTimeLocalized>
<d3p1:ArmingState>2</d3p1:ArmingState>
<d3p1:IsAlarmResponded>true</d3p1:IsAlarmResponded>
<d3p1:OverrideArmingState>3</d3p1:OverrideArmingState>
<d3p1:OverrideTimeStamp>2025-10-28T10:11:52.1575746-04:00</d3p1:OverrideTimeStamp>
<d3p1:PartitionID>1</d3p1:PartitionID>
</d3p1:PartitionInfo>
</d3p1:Partitions>
<d3p1:PrevArmingState>12</d3p1:PrevArmingState>
<d3p1:DeviceSerialText>sample string 2</d3p1:DeviceSerialText>
<d3p1:PromptForImportSecuritySettings>true</d3p1:PromptForImportSecuritySettings>
<d3p1:Zones>
<d3p1:ZoneInfo>
<d3p1:BatteryLevel>1</d3p1:BatteryLevel>
<d3p1:MaskDisabled>true</d3p1:MaskDisabled>
<d3p1:PartitionID>5</d3p1:PartitionID>
<d3p1:SignalStrength>1</d3p1:SignalStrength>
<d3p1:ZoneDescription>sample string 2</d3p1:ZoneDescription>
<d3p1:ZoneID>1</d3p1:ZoneID>
<d3p1:ZoneStatus>4</d3p1:ZoneStatus>
</d3p1:ZoneInfo>
<d3p1:ZoneInfo>
<d3p1:BatteryLevel>1</d3p1:BatteryLevel>
<d3p1:MaskDisabled>true</d3p1:MaskDisabled>
<d3p1:PartitionID>5</d3p1:PartitionID>
<d3p1:SignalStrength>1</d3p1:SignalStrength>
<d3p1:ZoneDescription>sample string 2</d3p1:ZoneDescription>
<d3p1:ZoneID>1</d3p1:ZoneID>
<d3p1:ZoneStatus>4</d3p1:ZoneStatus>
</d3p1:ZoneInfo>
</d3p1:Zones>
</PanelMetadataAndStatus>
<ResultData>sample string 4</ResultData>
</LocationBasicInfo>
<LocationBasicInfo>
<ISOccupied>true</ISOccupied>
<IsRental>true</IsRental>
<LocationID>1</LocationID>
<LocationName>sample string 2</LocationName>
<PanelMetadataAndStatus xmlns:d3p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
<d3p1:Bell1SupervisionFailure>true</d3p1:Bell1SupervisionFailure>
<d3p1:Bell2SupervisionFailure>true</d3p1:Bell2SupervisionFailure>
<d3p1:ConfigurationSequenceNumber>4</d3p1:ConfigurationSequenceNumber>
<d3p1:FirmwareVersion>sample string 14</d3p1:FirmwareVersion>
<d3p1:IsCoverTampered>true</d3p1:IsCoverTampered>
<d3p1:IsEntryDelayEnabled>true</d3p1:IsEntryDelayEnabled>
<d3p1:IsInACLoss>true</d3p1:IsInACLoss>
<d3p1:IsInEnrollmentMode>true</d3p1:IsInEnrollmentMode>
<d3p1:IsInLowBattery>true</d3p1:IsInLowBattery>
<d3p1:LastUpdatedTimestampTicks>3</d3p1:LastUpdatedTimestampTicks>
<d3p1:PanelType>sample string 13</d3p1:PanelType>
<d3p1:Partitions>
<d3p1:PartitionInfo>
<d3p1:AlarmTriggerTime>2025-10-28T10:11:52.1575746-04:00</d3p1:AlarmTriggerTime>
<d3p1:AlarmTriggerTimeLocalized>2025-10-28T10:11:52.1585838-04:00</d3p1:AlarmTriggerTimeLocalized>
<d3p1:ArmingState>2</d3p1:ArmingState>
<d3p1:IsAlarmResponded>true</d3p1:IsAlarmResponded>
<d3p1:OverrideArmingState>3</d3p1:OverrideArmingState>
<d3p1:OverrideTimeStamp>2025-10-28T10:11:52.1575746-04:00</d3p1:OverrideTimeStamp>
<d3p1:PartitionID>1</d3p1:PartitionID>
</d3p1:PartitionInfo>
<d3p1:PartitionInfo>
<d3p1:AlarmTriggerTime>2025-10-28T10:11:52.1575746-04:00</d3p1:AlarmTriggerTime>
<d3p1:AlarmTriggerTimeLocalized>2025-10-28T10:11:52.1585838-04:00</d3p1:AlarmTriggerTimeLocalized>
<d3p1:ArmingState>2</d3p1:ArmingState>
<d3p1:IsAlarmResponded>true</d3p1:IsAlarmResponded>
<d3p1:OverrideArmingState>3</d3p1:OverrideArmingState>
<d3p1:OverrideTimeStamp>2025-10-28T10:11:52.1575746-04:00</d3p1:OverrideTimeStamp>
<d3p1:PartitionID>1</d3p1:PartitionID>
</d3p1:PartitionInfo>
</d3p1:Partitions>
<d3p1:PrevArmingState>12</d3p1:PrevArmingState>
<d3p1:DeviceSerialText>sample string 2</d3p1:DeviceSerialText>
<d3p1:PromptForImportSecuritySettings>true</d3p1:PromptForImportSecuritySettings>
<d3p1:Zones>
<d3p1:ZoneInfo>
<d3p1:BatteryLevel>1</d3p1:BatteryLevel>
<d3p1:MaskDisabled>true</d3p1:MaskDisabled>
<d3p1:PartitionID>5</d3p1:PartitionID>
<d3p1:SignalStrength>1</d3p1:SignalStrength>
<d3p1:ZoneDescription>sample string 2</d3p1:ZoneDescription>
<d3p1:ZoneID>1</d3p1:ZoneID>
<d3p1:ZoneStatus>4</d3p1:ZoneStatus>
</d3p1:ZoneInfo>
<d3p1:ZoneInfo>
<d3p1:BatteryLevel>1</d3p1:BatteryLevel>
<d3p1:MaskDisabled>true</d3p1:MaskDisabled>
<d3p1:PartitionID>5</d3p1:PartitionID>
<d3p1:SignalStrength>1</d3p1:SignalStrength>
<d3p1:ZoneDescription>sample string 2</d3p1:ZoneDescription>
<d3p1:ZoneID>1</d3p1:ZoneID>
<d3p1:ZoneStatus>4</d3p1:ZoneStatus>
</d3p1:ZoneInfo>
</d3p1:Zones>
</PanelMetadataAndStatus>
<ResultData>sample string 4</ResultData>
</LocationBasicInfo>
</ArrayOfLocationBasicInfo>