GET api/v1/locations/{locationId}/partitions/zones/{listIdentifierId}

[TC2.1+] R Get the zones in different states like Alarms, Faults, Trouble, and Bypassed and whether it is Bypassable Zone or Not for Multipartition

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	Location ID	integer	Required
listIdentifierId	List Identifier Id	integer	Required
PartitionIds		string	None.

Body Parameters

None.

Response Information

Resource Description

ZonesListInStateResults

Name	Description	Type	Additional information
ZoneStatus		ZoneStatusListEx_V1	None.

Response Formats

application/json, text/json

Sample:

{
  "ZoneStatus": {
    "Zones": [
      {
        "PartitionId": 1,
        "Batterylevel": 2,
        "Signalstrength": 3,
        "zoneAdditionalInfo": {
          "SensorSerialNumber": "sample string 1",
          "LoopNumber": 2,
          "ResponseType": "sample string 3",
          "AlarmReportState": 4,
          "ZoneSupervisionType": 5,
          "ChimeState": 6,
          "DeviceType": 7
        },
        "CanBeBypassed": 4,
        "ZoneFlags": "sample string 5",
        "ZoneID": 6,
        "ZoneStatus": 7,
        "IsBypassableZone": 8,
        "IsSensingZone": 9,
        "ZoneTypeId": 10
      },
      {
        "PartitionId": 1,
        "Batterylevel": 2,
        "Signalstrength": 3,
        "zoneAdditionalInfo": {
          "SensorSerialNumber": "sample string 1",
          "LoopNumber": 2,
          "ResponseType": "sample string 3",
          "AlarmReportState": 4,
          "ZoneSupervisionType": 5,
          "ChimeState": 6,
          "DeviceType": 7
        },
        "CanBeBypassed": 4,
        "ZoneFlags": "sample string 5",
        "ZoneID": 6,
        "ZoneStatus": 7,
        "IsBypassableZone": 8,
        "IsSensingZone": 9,
        "ZoneTypeId": 10
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ZonesListInStateResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Security">
  <ZoneStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:Zones>
      <d2p1:ZoneStatusInfoWithPartitionId>
        <d2p1:IsBypassableZone>8</d2p1:IsBypassableZone>
        <d2p1:IsSensingZone>9</d2p1:IsSensingZone>
        <d2p1:ZoneID>6</d2p1:ZoneID>
        <d2p1:ZoneStatus>7</d2p1:ZoneStatus>
        <d2p1:ZoneTypeId>10</d2p1:ZoneTypeId>
        <d2p1:CanBeBypassed>4</d2p1:CanBeBypassed>
        <d2p1:ZoneFlags>sample string 5</d2p1:ZoneFlags>
        <d2p1:Batterylevel>2</d2p1:Batterylevel>
        <d2p1:PartitionId>1</d2p1:PartitionId>
        <d2p1:Signalstrength>3</d2p1:Signalstrength>
        <d2p1:zoneAdditionalInfo>
          <d2p1:AlarmReportState>4</d2p1:AlarmReportState>
          <d2p1:ChimeState>6</d2p1:ChimeState>
          <d2p1:DeviceType>7</d2p1:DeviceType>
          <d2p1:LoopNumber>2</d2p1:LoopNumber>
          <d2p1:ResponseType>sample string 3</d2p1:ResponseType>
          <d2p1:SensorSerialNumber>sample string 1</d2p1:SensorSerialNumber>
          <d2p1:ZoneSupervisionType>5</d2p1:ZoneSupervisionType>
        </d2p1:zoneAdditionalInfo>
      </d2p1:ZoneStatusInfoWithPartitionId>
      <d2p1:ZoneStatusInfoWithPartitionId>
        <d2p1:IsBypassableZone>8</d2p1:IsBypassableZone>
        <d2p1:IsSensingZone>9</d2p1:IsSensingZone>
        <d2p1:ZoneID>6</d2p1:ZoneID>
        <d2p1:ZoneStatus>7</d2p1:ZoneStatus>
        <d2p1:ZoneTypeId>10</d2p1:ZoneTypeId>
        <d2p1:CanBeBypassed>4</d2p1:CanBeBypassed>
        <d2p1:ZoneFlags>sample string 5</d2p1:ZoneFlags>
        <d2p1:Batterylevel>2</d2p1:Batterylevel>
        <d2p1:PartitionId>1</d2p1:PartitionId>
        <d2p1:Signalstrength>3</d2p1:Signalstrength>
        <d2p1:zoneAdditionalInfo>
          <d2p1:AlarmReportState>4</d2p1:AlarmReportState>
          <d2p1:ChimeState>6</d2p1:ChimeState>
          <d2p1:DeviceType>7</d2p1:DeviceType>
          <d2p1:LoopNumber>2</d2p1:LoopNumber>
          <d2p1:ResponseType>sample string 3</d2p1:ResponseType>
          <d2p1:SensorSerialNumber>sample string 1</d2p1:SensorSerialNumber>
          <d2p1:ZoneSupervisionType>5</d2p1:ZoneSupervisionType>
        </d2p1:zoneAdditionalInfo>
      </d2p1:ZoneStatusInfoWithPartitionId>
    </d2p1:Zones>
  </ZoneStatus>
</ZonesListInStateResults>