svcTC2API


Click here for a complete list of operations.

GetAllSensorsMaskStatus

Get the list of notification states permitted for this location.

Test

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

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/GetAllSensorsMaskStatus"

<?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>
    <GetAllSensorsMaskStatus xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
    </GetAllSensorsMaskStatus>
  </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>
    <GetAllSensorsMaskStatusResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetAllSensorsMaskStatusResult>
        <SensorMaskStatus>
          <SensorMaskStatus>
            <ZoneID>long</ZoneID>
            <ZoneDescription>string</ZoneDescription>
            <MaskStatus>int</MaskStatus>
            <NotificationCount>int</NotificationCount>
            <VideoTriggerCount>int</VideoTriggerCount>
            <PartitionID>int</PartitionID>
            <MaskDisabled>boolean</MaskDisabled>
          </SensorMaskStatus>
          <SensorMaskStatus>
            <ZoneID>long</ZoneID>
            <ZoneDescription>string</ZoneDescription>
            <MaskStatus>int</MaskStatus>
            <NotificationCount>int</NotificationCount>
            <VideoTriggerCount>int</VideoTriggerCount>
            <PartitionID>int</PartitionID>
            <MaskDisabled>boolean</MaskDisabled>
          </SensorMaskStatus>
        </SensorMaskStatus>
        <LocationLimitations>string</LocationLimitations>
      </GetAllSensorsMaskStatusResult>
    </GetAllSensorsMaskStatusResponse>
  </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>
    <GetAllSensorsMaskStatus xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
    </GetAllSensorsMaskStatus>
  </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>
    <GetAllSensorsMaskStatusResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetAllSensorsMaskStatusResult>
        <SensorMaskStatus>
          <SensorMaskStatus>
            <ZoneID>long</ZoneID>
            <ZoneDescription>string</ZoneDescription>
            <MaskStatus>int</MaskStatus>
            <NotificationCount>int</NotificationCount>
            <VideoTriggerCount>int</VideoTriggerCount>
            <PartitionID>int</PartitionID>
            <MaskDisabled>boolean</MaskDisabled>
          </SensorMaskStatus>
          <SensorMaskStatus>
            <ZoneID>long</ZoneID>
            <ZoneDescription>string</ZoneDescription>
            <MaskStatus>int</MaskStatus>
            <NotificationCount>int</NotificationCount>
            <VideoTriggerCount>int</VideoTriggerCount>
            <PartitionID>int</PartitionID>
            <MaskDisabled>boolean</MaskDisabled>
          </SensorMaskStatus>
        </SensorMaskStatus>
        <LocationLimitations>string</LocationLimitations>
      </GetAllSensorsMaskStatusResult>
    </GetAllSensorsMaskStatusResponse>
  </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/GetAllSensorsMaskStatus?SessionID=string&LocationID=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"?>
<SensorEventResult xmlns="https://services.alarmnet.com/TC2/">
  <SensorMaskStatus>
    <SensorMaskStatus>
      <ZoneID>long</ZoneID>
      <ZoneDescription>string</ZoneDescription>
      <MaskStatus>int</MaskStatus>
      <NotificationCount>int</NotificationCount>
      <VideoTriggerCount>int</VideoTriggerCount>
      <PartitionID>int</PartitionID>
      <MaskDisabled>boolean</MaskDisabled>
    </SensorMaskStatus>
    <SensorMaskStatus>
      <ZoneID>long</ZoneID>
      <ZoneDescription>string</ZoneDescription>
      <MaskStatus>int</MaskStatus>
      <NotificationCount>int</NotificationCount>
      <VideoTriggerCount>int</VideoTriggerCount>
      <PartitionID>int</PartitionID>
      <MaskDisabled>boolean</MaskDisabled>
    </SensorMaskStatus>
  </SensorMaskStatus>
  <LocationLimitations>string</LocationLimitations>
</SensorEventResult>

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/GetAllSensorsMaskStatus HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<SensorEventResult xmlns="https://services.alarmnet.com/TC2/">
  <SensorMaskStatus>
    <SensorMaskStatus>
      <ZoneID>long</ZoneID>
      <ZoneDescription>string</ZoneDescription>
      <MaskStatus>int</MaskStatus>
      <NotificationCount>int</NotificationCount>
      <VideoTriggerCount>int</VideoTriggerCount>
      <PartitionID>int</PartitionID>
      <MaskDisabled>boolean</MaskDisabled>
    </SensorMaskStatus>
    <SensorMaskStatus>
      <ZoneID>long</ZoneID>
      <ZoneDescription>string</ZoneDescription>
      <MaskStatus>int</MaskStatus>
      <NotificationCount>int</NotificationCount>
      <VideoTriggerCount>int</VideoTriggerCount>
      <PartitionID>int</PartitionID>
      <MaskDisabled>boolean</MaskDisabled>
    </SensorMaskStatus>
  </SensorMaskStatus>
  <LocationLimitations>string</LocationLimitations>
</SensorEventResult>