GET api/v1/locations/{locationId}/partitions/status
Request for Full status of Security Panel for the Given Location and User.Added CanBeBypassable flag to determine zone is bypassable or not
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId |
Location ID |
integer |
Required |
LastSequenceNumber | integer |
None. |
|
LastUpdatedTimestampTicks | integer |
None. |
|
PartitionIds | string |
None. |
Body Parameters
None.
Response Information
Resource Description
PanelStatusResults
PanelStatusResultsName | Description | Type | Additional information |
---|---|---|---|
PanelStatus | PanelStatusInfoExV1 |
None. |
|
ArmingState |
Global arming state |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "PanelStatus": { "Zones": [ { "ZoneID": 1, "ZoneStatus": 2, "IsBypassableZone": 3, "IsSensingZone": 4, "ZoneTypeId": 5, "PartitionID": 6, "AlarmTriggerTime": "2025-04-01T23:49:58.9425184-04:00" }, { "ZoneID": 1, "ZoneStatus": 2, "IsBypassableZone": 3, "IsSensingZone": 4, "ZoneTypeId": 5, "PartitionID": 6, "AlarmTriggerTime": "2025-04-01T23:49:58.9425184-04:00" } ], "SyncSecDeviceFlag": true, "LastUpdatedTimestampTicks": 2, "ConfigurationSequenceNumber": 3, "IsInACLoss": true, "IsCoverTampered": true, "IsInLowBattery": true, "Bell1SupervisionFailure": true, "Bell2SupervisionFailure": true, "IsInRfJam": true, "IsInBatteryMissing": true, "Partitions": [ { "PartitionName": "sample string 1", "IsStayArmed": true, "IsFireEnabled": true, "IsCommonEnabled": true, "IsLocked": true, "IsNewPartition": true, "IsNightStayEnabled": 7, "ExitDelayTimer": 8, "PartitionID": 9, "PartitionArmingState": 10, "ArmingState": 10, "OverrideArmingState": 11, "OverrideTimeStamp": "2025-04-01T23:49:58.9425184-04:00", "IsAlarmResponded": true, "AlarmTriggerTime": "2025-04-01T23:49:58.9425184-04:00", "AlarmTriggerTimeLocalized": "2025-04-01T23:49:58.9425184-04:00" }, { "PartitionName": "sample string 1", "IsStayArmed": true, "IsFireEnabled": true, "IsCommonEnabled": true, "IsLocked": true, "IsNewPartition": true, "IsNightStayEnabled": 7, "ExitDelayTimer": 8, "PartitionID": 9, "PartitionArmingState": 10, "ArmingState": 10, "OverrideArmingState": 11, "OverrideTimeStamp": "2025-04-01T23:49:58.9425184-04:00", "IsAlarmResponded": true, "AlarmTriggerTime": "2025-04-01T23:49:58.9425184-04:00", "AlarmTriggerTimeLocalized": "2025-04-01T23:49:58.9425184-04:00" } ] }, "ArmingState": 1 }
application/xml, text/xml
Sample:
<PanelStatusResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Security"> <ArmingState>1</ArmingState> <PanelStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security"> <d2p1:Bell1SupervisionFailure>true</d2p1:Bell1SupervisionFailure> <d2p1:Bell2SupervisionFailure>true</d2p1:Bell2SupervisionFailure> <d2p1:ConfigurationSequenceNumber>3</d2p1:ConfigurationSequenceNumber> <d2p1:IsCoverTampered>true</d2p1:IsCoverTampered> <d2p1:IsInACLoss>true</d2p1:IsInACLoss> <d2p1:IsInBatteryMissing>true</d2p1:IsInBatteryMissing> <d2p1:IsInLowBattery>true</d2p1:IsInLowBattery> <d2p1:IsInRfJam>true</d2p1:IsInRfJam> <d2p1:LastUpdatedTimestampTicks>2</d2p1:LastUpdatedTimestampTicks> <d2p1:Partitions> <d2p1:PartitionDetails> <d2p1:AlarmTriggerTime>2025-04-01T23:49:58.9425184-04:00</d2p1:AlarmTriggerTime> <d2p1:AlarmTriggerTimeLocalized>2025-04-01T23:49:58.9425184-04:00</d2p1:AlarmTriggerTimeLocalized> <d2p1:ArmingState>10</d2p1:ArmingState> <d2p1:IsAlarmResponded>true</d2p1:IsAlarmResponded> <d2p1:OverrideArmingState>11</d2p1:OverrideArmingState> <d2p1:OverrideTimeStamp>2025-04-01T23:49:58.9425184-04:00</d2p1:OverrideTimeStamp> <d2p1:PartitionID>9</d2p1:PartitionID> <d2p1:ExitDelayTimer>8</d2p1:ExitDelayTimer> <d2p1:IsCommonEnabled>true</d2p1:IsCommonEnabled> <d2p1:IsFireEnabled>true</d2p1:IsFireEnabled> <d2p1:IsLocked>true</d2p1:IsLocked> <d2p1:IsNewPartition>true</d2p1:IsNewPartition> <d2p1:IsNightStayEnabled>7</d2p1:IsNightStayEnabled> <d2p1:IsStayArmed>true</d2p1:IsStayArmed> <d2p1:PartitionName>sample string 1</d2p1:PartitionName> </d2p1:PartitionDetails> <d2p1:PartitionDetails> <d2p1:AlarmTriggerTime>2025-04-01T23:49:58.9425184-04:00</d2p1:AlarmTriggerTime> <d2p1:AlarmTriggerTimeLocalized>2025-04-01T23:49:58.9425184-04:00</d2p1:AlarmTriggerTimeLocalized> <d2p1:ArmingState>10</d2p1:ArmingState> <d2p1:IsAlarmResponded>true</d2p1:IsAlarmResponded> <d2p1:OverrideArmingState>11</d2p1:OverrideArmingState> <d2p1:OverrideTimeStamp>2025-04-01T23:49:58.9425184-04:00</d2p1:OverrideTimeStamp> <d2p1:PartitionID>9</d2p1:PartitionID> <d2p1:ExitDelayTimer>8</d2p1:ExitDelayTimer> <d2p1:IsCommonEnabled>true</d2p1:IsCommonEnabled> <d2p1:IsFireEnabled>true</d2p1:IsFireEnabled> <d2p1:IsLocked>true</d2p1:IsLocked> <d2p1:IsNewPartition>true</d2p1:IsNewPartition> <d2p1:IsNightStayEnabled>7</d2p1:IsNightStayEnabled> <d2p1:IsStayArmed>true</d2p1:IsStayArmed> <d2p1:PartitionName>sample string 1</d2p1:PartitionName> </d2p1:PartitionDetails> </d2p1:Partitions> <d2p1:SyncSecDeviceFlag>true</d2p1:SyncSecDeviceFlag> <d2p1:Zones> <d2p1:ZoneStatusInfoEx_V1> <d2p1:AlarmTriggerTime>2025-04-01T23:49:58.9425184-04:00</d2p1:AlarmTriggerTime> <d2p1:IsBypassableZone>3</d2p1:IsBypassableZone> <d2p1:IsSensingZone>4</d2p1:IsSensingZone> <d2p1:PartitionID>6</d2p1:PartitionID> <d2p1:ZoneID>1</d2p1:ZoneID> <d2p1:ZoneStatus>2</d2p1:ZoneStatus> <d2p1:ZoneTypeId>5</d2p1:ZoneTypeId> </d2p1:ZoneStatusInfoEx_V1> <d2p1:ZoneStatusInfoEx_V1> <d2p1:AlarmTriggerTime>2025-04-01T23:49:58.9425184-04:00</d2p1:AlarmTriggerTime> <d2p1:IsBypassableZone>3</d2p1:IsBypassableZone> <d2p1:IsSensingZone>4</d2p1:IsSensingZone> <d2p1:PartitionID>6</d2p1:PartitionID> <d2p1:ZoneID>1</d2p1:ZoneID> <d2p1:ZoneStatus>2</d2p1:ZoneStatus> <d2p1:ZoneTypeId>5</d2p1:ZoneTypeId> </d2p1:ZoneStatusInfoEx_V1> </d2p1:Zones> </PanelStatus> </PanelStatusResults>