GET api/v1/locations/{locationId}/devices/security/metadata?lastSequenceNumber={lastSequenceNumber}&lastUpdatedTimestampTicks={lastUpdatedTimestampTicks}&partitionId={partitionId}

Request for Metadata and 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	LastSequenceNumber	integer	Required
lastUpdatedTimestampTicks	LastUpdatedTimestampTicks	integer	Required
partitionId	PartitionID	integer	Required

Body Parameters

None.

Response Information

Resource Description

PanelMetadataAndStatusResultsEx_V1

Name	Type	Additional information
PanelMetadataAndStatus	PanelMetadataAndStatusInfoEx_V1	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PanelMetadataAndStatus": {
    "Zones": [
      {
        "ZoneID": 1,
        "ZoneDescription": "sample string 2",
        "ZoneStatus": 3,
        "PartitionID": 4,
        "CanBeBypassed": 5,
        "AlarmTriggerTime": "2025-04-01T23:55:13.5374864-04:00",
        "AlarmTriggerTimeLocalized": "2025-04-01T23:55:13.5374864-04:00",
        "ZoneTypeID": 6,
        "DeviceType": 7
      },
      {
        "ZoneID": 1,
        "ZoneDescription": "sample string 2",
        "ZoneStatus": 3,
        "PartitionID": 4,
        "CanBeBypassed": 5,
        "AlarmTriggerTime": "2025-04-01T23:55:13.5374864-04:00",
        "AlarmTriggerTimeLocalized": "2025-04-01T23:55:13.5374864-04:00",
        "ZoneTypeID": 6,
        "DeviceType": 7
      }
    ],
    "PromptForImportSecuritySettings": true,
    "SyncSecDeviceFlag": true,
    "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-01T23:55:13.5374864-04:00",
        "IsAlarmResponded": true,
        "AlarmTriggerTime": "2025-04-01T23:55:13.5374864-04:00",
        "AlarmTriggerTimeLocalized": "2025-04-01T23:55:13.5374864-04:00"
      },
      {
        "PartitionID": 1,
        "PartitionArmingState": 2,
        "ArmingState": 2,
        "OverrideArmingState": 3,
        "OverrideTimeStamp": "2025-04-01T23:55:13.5374864-04:00",
        "IsAlarmResponded": true,
        "AlarmTriggerTime": "2025-04-01T23:55:13.5374864-04:00",
        "AlarmTriggerTimeLocalized": "2025-04-01T23:55:13.5374864-04:00"
      }
    ]
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<PanelMetadataAndStatusResultsEx_V1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Security">
  <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>
  <PanelMetadataAndStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:Bell1SupervisionFailure>true</d2p1:Bell1SupervisionFailure>
    <d2p1:Bell2SupervisionFailure>true</d2p1:Bell2SupervisionFailure>
    <d2p1:ConfigurationSequenceNumber>4</d2p1:ConfigurationSequenceNumber>
    <d2p1:FirmwareVersion>sample string 12</d2p1:FirmwareVersion>
    <d2p1:IsCoverTampered>true</d2p1:IsCoverTampered>
    <d2p1:IsInACLoss>true</d2p1:IsInACLoss>
    <d2p1:IsInLowBattery>true</d2p1:IsInLowBattery>
    <d2p1:LastUpdatedTimestampTicks>3</d2p1:LastUpdatedTimestampTicks>
    <d2p1:PanelType>sample string 11</d2p1:PanelType>
    <d2p1:Partitions>
      <d2p1:PartitionInfo>
        <d2p1:AlarmTriggerTime>2025-04-01T23:55:13.5374864-04:00</d2p1:AlarmTriggerTime>
        <d2p1:AlarmTriggerTimeLocalized>2025-04-01T23:55:13.5374864-04:00</d2p1:AlarmTriggerTimeLocalized>
        <d2p1:ArmingState>2</d2p1:ArmingState>
        <d2p1:IsAlarmResponded>true</d2p1:IsAlarmResponded>
        <d2p1:OverrideArmingState>3</d2p1:OverrideArmingState>
        <d2p1:OverrideTimeStamp>2025-04-01T23:55:13.5374864-04:00</d2p1:OverrideTimeStamp>
        <d2p1:PartitionID>1</d2p1:PartitionID>
      </d2p1:PartitionInfo>
      <d2p1:PartitionInfo>
        <d2p1:AlarmTriggerTime>2025-04-01T23:55:13.5374864-04:00</d2p1:AlarmTriggerTime>
        <d2p1:AlarmTriggerTimeLocalized>2025-04-01T23:55:13.5374864-04:00</d2p1:AlarmTriggerTimeLocalized>
        <d2p1:ArmingState>2</d2p1:ArmingState>
        <d2p1:IsAlarmResponded>true</d2p1:IsAlarmResponded>
        <d2p1:OverrideArmingState>3</d2p1:OverrideArmingState>
        <d2p1:OverrideTimeStamp>2025-04-01T23:55:13.5374864-04:00</d2p1:OverrideTimeStamp>
        <d2p1:PartitionID>1</d2p1:PartitionID>
      </d2p1:PartitionInfo>
    </d2p1:Partitions>
    <d2p1:PrevArmingState>10</d2p1:PrevArmingState>
    <d2p1:SyncSecDeviceFlag>true</d2p1:SyncSecDeviceFlag>
    <d2p1:PromptForImportSecuritySettings>true</d2p1:PromptForImportSecuritySettings>
    <d2p1:Zones>
      <d2p1:ZoneInfoEx>
        <d2p1:AlarmTriggerTime>2025-04-01T23:55:13.5374864-04:00</d2p1:AlarmTriggerTime>
        <d2p1:AlarmTriggerTimeLocalized>2025-04-01T23:55:13.5374864-04:00</d2p1:AlarmTriggerTimeLocalized>
        <d2p1:CanBeBypassed>5</d2p1:CanBeBypassed>
        <d2p1:DeviceType>7</d2p1:DeviceType>
        <d2p1:PartitionID>4</d2p1:PartitionID>
        <d2p1:ZoneDescription>sample string 2</d2p1:ZoneDescription>
        <d2p1:ZoneID>1</d2p1:ZoneID>
        <d2p1:ZoneStatus>3</d2p1:ZoneStatus>
        <d2p1:ZoneTypeID>6</d2p1:ZoneTypeID>
      </d2p1:ZoneInfoEx>
      <d2p1:ZoneInfoEx>
        <d2p1:AlarmTriggerTime>2025-04-01T23:55:13.5374864-04:00</d2p1:AlarmTriggerTime>
        <d2p1:AlarmTriggerTimeLocalized>2025-04-01T23:55:13.5374864-04:00</d2p1:AlarmTriggerTimeLocalized>
        <d2p1:CanBeBypassed>5</d2p1:CanBeBypassed>
        <d2p1:DeviceType>7</d2p1:DeviceType>
        <d2p1:PartitionID>4</d2p1:PartitionID>
        <d2p1:ZoneDescription>sample string 2</d2p1:ZoneDescription>
        <d2p1:ZoneID>1</d2p1:ZoneID>
        <d2p1:ZoneStatus>3</d2p1:ZoneStatus>
        <d2p1:ZoneTypeID>6</d2p1:ZoneTypeID>
      </d2p1:ZoneInfoEx>
    </d2p1:Zones>
  </PanelMetadataAndStatus>
</PanelMetadataAndStatusResultsEx_V1>