GET api/v1/account/user/current/locations/{locationId}/SecurityStatus

Request for PanelMetadata and security status of each partition for the Given Location and User.

Request Information

URI Parameters

Name	Type	Additional information
LastSequenceNumber	integer	None.
LastUpdatedTimestampTicks	integer	None.
PartitionIds	string	None.
locationId	string	None.

Body Parameters

List of Location ID

Collection of integer

Request Formats

application/json, text/json

Sample:

[
  1,
  2
]

application/xml, text/xml

Sample:

<ArrayOflong xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <long>1</long>
  <long>2</long>
</ArrayOflong>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LocationBasicInfo wiht partition security status

SecurityPanelStatusResults

Name	Type	Additional information
lstLocationBasicInfo	Collection of LocationBasicInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "lstLocationBasicInfo": [
    {
      "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,
        "PrevArmingState": 10,
        "PanelType": "sample string 11",
        "FirmwareVersion": "sample string 12",
        "Partitions": [
          {
            "PartitionID": 1,
            "PartitionArmingState": 2,
            "ArmingState": 2,
            "OverrideArmingState": 3,
            "OverrideTimeStamp": "2025-04-24T03:32:21.590364-04:00",
            "IsAlarmResponded": true,
            "AlarmTriggerTime": "2025-04-24T03:32:21.590364-04:00",
            "AlarmTriggerTimeLocalized": "2025-04-24T03:32:21.590364-04:00"
          },
          {
            "PartitionID": 1,
            "PartitionArmingState": 2,
            "ArmingState": 2,
            "OverrideArmingState": 3,
            "OverrideTimeStamp": "2025-04-24T03:32:21.590364-04:00",
            "IsAlarmResponded": true,
            "AlarmTriggerTime": "2025-04-24T03:32:21.590364-04:00",
            "AlarmTriggerTimeLocalized": "2025-04-24T03:32:21.590364-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,
        "PrevArmingState": 10,
        "PanelType": "sample string 11",
        "FirmwareVersion": "sample string 12",
        "Partitions": [
          {
            "PartitionID": 1,
            "PartitionArmingState": 2,
            "ArmingState": 2,
            "OverrideArmingState": 3,
            "OverrideTimeStamp": "2025-04-24T03:32:21.590364-04:00",
            "IsAlarmResponded": true,
            "AlarmTriggerTime": "2025-04-24T03:32:21.590364-04:00",
            "AlarmTriggerTimeLocalized": "2025-04-24T03:32:21.590364-04:00"
          },
          {
            "PartitionID": 1,
            "PartitionArmingState": 2,
            "ArmingState": 2,
            "OverrideArmingState": 3,
            "OverrideTimeStamp": "2025-04-24T03:32:21.590364-04:00",
            "IsAlarmResponded": true,
            "AlarmTriggerTime": "2025-04-24T03:32:21.590364-04:00",
            "AlarmTriggerTimeLocalized": "2025-04-24T03:32:21.590364-04:00"
          }
        ]
      },
      "IsRental": true
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<SecurityPanelStatusResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.UserConfiguration">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <lstLocationBasicInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain">
    <d2p1:LocationBasicInfo>
      <d2p1:ISOccupied>true</d2p1:ISOccupied>
      <d2p1:IsRental>true</d2p1:IsRental>
      <d2p1:LocationID>1</d2p1:LocationID>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:PanelMetadataAndStatus xmlns:d4p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
        <d4p1:Bell1SupervisionFailure>true</d4p1:Bell1SupervisionFailure>
        <d4p1:Bell2SupervisionFailure>true</d4p1:Bell2SupervisionFailure>
        <d4p1:ConfigurationSequenceNumber>4</d4p1:ConfigurationSequenceNumber>
        <d4p1:FirmwareVersion>sample string 12</d4p1:FirmwareVersion>
        <d4p1:IsCoverTampered>true</d4p1:IsCoverTampered>
        <d4p1:IsInACLoss>true</d4p1:IsInACLoss>
        <d4p1:IsInLowBattery>true</d4p1:IsInLowBattery>
        <d4p1:LastUpdatedTimestampTicks>3</d4p1:LastUpdatedTimestampTicks>
        <d4p1:PanelType>sample string 11</d4p1:PanelType>
        <d4p1:Partitions>
          <d4p1:PartitionInfo>
            <d4p1:AlarmTriggerTime>2025-04-24T03:32:21.590364-04:00</d4p1:AlarmTriggerTime>
            <d4p1:AlarmTriggerTimeLocalized>2025-04-24T03:32:21.590364-04:00</d4p1:AlarmTriggerTimeLocalized>
            <d4p1:ArmingState>2</d4p1:ArmingState>
            <d4p1:IsAlarmResponded>true</d4p1:IsAlarmResponded>
            <d4p1:OverrideArmingState>3</d4p1:OverrideArmingState>
            <d4p1:OverrideTimeStamp>2025-04-24T03:32:21.590364-04:00</d4p1:OverrideTimeStamp>
            <d4p1:PartitionID>1</d4p1:PartitionID>
          </d4p1:PartitionInfo>
          <d4p1:PartitionInfo>
            <d4p1:AlarmTriggerTime>2025-04-24T03:32:21.590364-04:00</d4p1:AlarmTriggerTime>
            <d4p1:AlarmTriggerTimeLocalized>2025-04-24T03:32:21.590364-04:00</d4p1:AlarmTriggerTimeLocalized>
            <d4p1:ArmingState>2</d4p1:ArmingState>
            <d4p1:IsAlarmResponded>true</d4p1:IsAlarmResponded>
            <d4p1:OverrideArmingState>3</d4p1:OverrideArmingState>
            <d4p1:OverrideTimeStamp>2025-04-24T03:32:21.590364-04:00</d4p1:OverrideTimeStamp>
            <d4p1:PartitionID>1</d4p1:PartitionID>
          </d4p1:PartitionInfo>
        </d4p1:Partitions>
        <d4p1:PrevArmingState>10</d4p1:PrevArmingState>
        <d4p1:DeviceSerialText>sample string 2</d4p1:DeviceSerialText>
        <d4p1:PromptForImportSecuritySettings>true</d4p1:PromptForImportSecuritySettings>
        <d4p1:Zones>
          <d4p1:ZoneInfo>
            <d4p1:BatteryLevel>1</d4p1:BatteryLevel>
            <d4p1:MaskDisabled>true</d4p1:MaskDisabled>
            <d4p1:PartitionID>5</d4p1:PartitionID>
            <d4p1:SignalStrength>1</d4p1:SignalStrength>
            <d4p1:ZoneDescription>sample string 2</d4p1:ZoneDescription>
            <d4p1:ZoneID>1</d4p1:ZoneID>
            <d4p1:ZoneStatus>4</d4p1:ZoneStatus>
          </d4p1:ZoneInfo>
          <d4p1:ZoneInfo>
            <d4p1:BatteryLevel>1</d4p1:BatteryLevel>
            <d4p1:MaskDisabled>true</d4p1:MaskDisabled>
            <d4p1:PartitionID>5</d4p1:PartitionID>
            <d4p1:SignalStrength>1</d4p1:SignalStrength>
            <d4p1:ZoneDescription>sample string 2</d4p1:ZoneDescription>
            <d4p1:ZoneID>1</d4p1:ZoneID>
            <d4p1:ZoneStatus>4</d4p1:ZoneStatus>
          </d4p1:ZoneInfo>
        </d4p1:Zones>
      </d2p1:PanelMetadataAndStatus>
      <d2p1:ResultData>sample string 4</d2p1:ResultData>
    </d2p1:LocationBasicInfo>
    <d2p1:LocationBasicInfo>
      <d2p1:ISOccupied>true</d2p1:ISOccupied>
      <d2p1:IsRental>true</d2p1:IsRental>
      <d2p1:LocationID>1</d2p1:LocationID>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:PanelMetadataAndStatus xmlns:d4p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
        <d4p1:Bell1SupervisionFailure>true</d4p1:Bell1SupervisionFailure>
        <d4p1:Bell2SupervisionFailure>true</d4p1:Bell2SupervisionFailure>
        <d4p1:ConfigurationSequenceNumber>4</d4p1:ConfigurationSequenceNumber>
        <d4p1:FirmwareVersion>sample string 12</d4p1:FirmwareVersion>
        <d4p1:IsCoverTampered>true</d4p1:IsCoverTampered>
        <d4p1:IsInACLoss>true</d4p1:IsInACLoss>
        <d4p1:IsInLowBattery>true</d4p1:IsInLowBattery>
        <d4p1:LastUpdatedTimestampTicks>3</d4p1:LastUpdatedTimestampTicks>
        <d4p1:PanelType>sample string 11</d4p1:PanelType>
        <d4p1:Partitions>
          <d4p1:PartitionInfo>
            <d4p1:AlarmTriggerTime>2025-04-24T03:32:21.590364-04:00</d4p1:AlarmTriggerTime>
            <d4p1:AlarmTriggerTimeLocalized>2025-04-24T03:32:21.590364-04:00</d4p1:AlarmTriggerTimeLocalized>
            <d4p1:ArmingState>2</d4p1:ArmingState>
            <d4p1:IsAlarmResponded>true</d4p1:IsAlarmResponded>
            <d4p1:OverrideArmingState>3</d4p1:OverrideArmingState>
            <d4p1:OverrideTimeStamp>2025-04-24T03:32:21.590364-04:00</d4p1:OverrideTimeStamp>
            <d4p1:PartitionID>1</d4p1:PartitionID>
          </d4p1:PartitionInfo>
          <d4p1:PartitionInfo>
            <d4p1:AlarmTriggerTime>2025-04-24T03:32:21.590364-04:00</d4p1:AlarmTriggerTime>
            <d4p1:AlarmTriggerTimeLocalized>2025-04-24T03:32:21.590364-04:00</d4p1:AlarmTriggerTimeLocalized>
            <d4p1:ArmingState>2</d4p1:ArmingState>
            <d4p1:IsAlarmResponded>true</d4p1:IsAlarmResponded>
            <d4p1:OverrideArmingState>3</d4p1:OverrideArmingState>
            <d4p1:OverrideTimeStamp>2025-04-24T03:32:21.590364-04:00</d4p1:OverrideTimeStamp>
            <d4p1:PartitionID>1</d4p1:PartitionID>
          </d4p1:PartitionInfo>
        </d4p1:Partitions>
        <d4p1:PrevArmingState>10</d4p1:PrevArmingState>
        <d4p1:DeviceSerialText>sample string 2</d4p1:DeviceSerialText>
        <d4p1:PromptForImportSecuritySettings>true</d4p1:PromptForImportSecuritySettings>
        <d4p1:Zones>
          <d4p1:ZoneInfo>
            <d4p1:BatteryLevel>1</d4p1:BatteryLevel>
            <d4p1:MaskDisabled>true</d4p1:MaskDisabled>
            <d4p1:PartitionID>5</d4p1:PartitionID>
            <d4p1:SignalStrength>1</d4p1:SignalStrength>
            <d4p1:ZoneDescription>sample string 2</d4p1:ZoneDescription>
            <d4p1:ZoneID>1</d4p1:ZoneID>
            <d4p1:ZoneStatus>4</d4p1:ZoneStatus>
          </d4p1:ZoneInfo>
          <d4p1:ZoneInfo>
            <d4p1:BatteryLevel>1</d4p1:BatteryLevel>
            <d4p1:MaskDisabled>true</d4p1:MaskDisabled>
            <d4p1:PartitionID>5</d4p1:PartitionID>
            <d4p1:SignalStrength>1</d4p1:SignalStrength>
            <d4p1:ZoneDescription>sample string 2</d4p1:ZoneDescription>
            <d4p1:ZoneID>1</d4p1:ZoneID>
            <d4p1:ZoneStatus>4</d4p1:ZoneStatus>
          </d4p1:ZoneInfo>
        </d4p1:Zones>
      </d2p1:PanelMetadataAndStatus>
      <d2p1:ResultData>sample string 4</d2p1:ResultData>
    </d2p1:LocationBasicInfo>
  </lstLocationBasicInfo>
</SecurityPanelStatusResults>