svcTC2API


Click here for a complete list of operations.

GetZonesListInStateEx

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

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
LocationID:
PartitionID:
ListIdentifierID:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /TC21API/TC2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.alarmnet.com/TC2/GetZonesListInStateEx"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetZonesListInStateEx xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <PartitionID>int</PartitionID>
      <ListIdentifierID>int</ListIdentifierID>
    </GetZonesListInStateEx>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetZonesListInStateExResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetZonesListInStateExResult>
        <ZoneStatus>
          <Zones>
            <ZoneStatusInfoEx xsi:nil="true" />
            <ZoneStatusInfoEx xsi:nil="true" />
          </Zones>
        </ZoneStatus>
      </GetZonesListInStateExResult>
    </GetZonesListInStateExResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /TC21API/TC2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetZonesListInStateEx xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <PartitionID>int</PartitionID>
      <ListIdentifierID>int</ListIdentifierID>
    </GetZonesListInStateEx>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetZonesListInStateExResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetZonesListInStateExResult>
        <ZoneStatus>
          <Zones>
            <ZoneStatusInfoEx xsi:nil="true" />
            <ZoneStatusInfoEx xsi:nil="true" />
          </Zones>
        </ZoneStatus>
      </GetZonesListInStateExResult>
    </GetZonesListInStateExResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /TC21API/TC2.asmx/GetZonesListInStateEx?SessionID=string&LocationID=string&PartitionID=string&ListIdentifierID=string HTTP/1.1
Host: rs.alarmnet.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetZonesListInStateExResult xmlns="https://services.alarmnet.com/TC2/">
  <ZoneStatus>
    <Zones>
      <ZoneStatusInfoEx CanBeBypassed="int" ZoneFlags="string" />
      <ZoneStatusInfoEx CanBeBypassed="int" ZoneFlags="string" />
    </Zones>
  </ZoneStatus>
</GetZonesListInStateExResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /TC21API/TC2.asmx/GetZonesListInStateEx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&LocationID=string&PartitionID=string&ListIdentifierID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetZonesListInStateExResult xmlns="https://services.alarmnet.com/TC2/">
  <ZoneStatus>
    <Zones>
      <ZoneStatusInfoEx CanBeBypassed="int" ZoneFlags="string" />
      <ZoneStatusInfoEx CanBeBypassed="int" ZoneFlags="string" />
    </Zones>
  </ZoneStatus>
</GetZonesListInStateExResult>