GET api/v1/locations/{locationId}/devices/security/partitions/{partitionId}/zones/state?listIdentifierId={listIdentifierId}

[Enriched Method] Get the zones in different states like Alarms, Faults, Trouble, and Bypassed and whether it is Bypassable Zone or Not")]

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	Location ID	integer	Required
partitionId	Partition ID	integer	Required
listIdentifierId	ListIdentifier ID	integer	Required

Body Parameters

None.

Response Information

Resource Description

GetZonesListInStateExResult

Name	Type	Additional information
ZoneStatus	ZoneStatusListEx	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ZoneStatus": {
    "Zones": [
      {
        "CanBeBypassed": 1,
        "ZoneFlags": "sample string 2",
        "ZoneID": 3,
        "ZoneStatus": 4,
        "IsBypassableZone": 5,
        "IsSensingZone": 6,
        "ZoneTypeId": 7
      },
      {
        "CanBeBypassed": 1,
        "ZoneFlags": "sample string 2",
        "ZoneID": 3,
        "ZoneStatus": 4,
        "IsBypassableZone": 5,
        "IsSensingZone": 6,
        "ZoneTypeId": 7
      }
    ]
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<GetZonesListInStateExResult 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>
  <ZoneStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:Zones>
      <d2p1:ZoneStatusInfoEx>
        <d2p1:IsBypassableZone>5</d2p1:IsBypassableZone>
        <d2p1:IsSensingZone>6</d2p1:IsSensingZone>
        <d2p1:ZoneID>3</d2p1:ZoneID>
        <d2p1:ZoneStatus>4</d2p1:ZoneStatus>
        <d2p1:ZoneTypeId>7</d2p1:ZoneTypeId>
        <d2p1:CanBeBypassed>1</d2p1:CanBeBypassed>
        <d2p1:ZoneFlags>sample string 2</d2p1:ZoneFlags>
      </d2p1:ZoneStatusInfoEx>
      <d2p1:ZoneStatusInfoEx>
        <d2p1:IsBypassableZone>5</d2p1:IsBypassableZone>
        <d2p1:IsSensingZone>6</d2p1:IsSensingZone>
        <d2p1:ZoneID>3</d2p1:ZoneID>
        <d2p1:ZoneStatus>4</d2p1:ZoneStatus>
        <d2p1:ZoneTypeId>7</d2p1:ZoneTypeId>
        <d2p1:CanBeBypassed>1</d2p1:CanBeBypassed>
        <d2p1:ZoneFlags>sample string 2</d2p1:ZoneFlags>
      </d2p1:ZoneStatusInfoEx>
    </d2p1:Zones>
  </ZoneStatus>
</GetZonesListInStateExResult>