svcTC2API


Click here for a complete list of operations.

GetVideoPIRConfiguration

Retrieve the current configuration information for the given Video PIR.

Test

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

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

<?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>
    <GetVideoPIRConfiguration xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <AdditionalInfo>string</AdditionalInfo>
    </GetVideoPIRConfiguration>
  </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>
    <GetVideoPIRConfigurationResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetVideoPIRConfigurationResult>
        <DeviceName>string</DeviceName>
        <FeatureFlags>string</FeatureFlags>
        <SYSTEM_Data>string</SYSTEM_Data>
        <VIDEO_Data>string</VIDEO_Data>
        <MOTION_Data>string</MOTION_Data>
        <EVENT_Data>string</EVENT_Data>
      </GetVideoPIRConfigurationResult>
    </GetVideoPIRConfigurationResponse>
  </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>
    <GetVideoPIRConfiguration xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <AdditionalInfo>string</AdditionalInfo>
    </GetVideoPIRConfiguration>
  </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>
    <GetVideoPIRConfigurationResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetVideoPIRConfigurationResult>
        <DeviceName>string</DeviceName>
        <FeatureFlags>string</FeatureFlags>
        <SYSTEM_Data>string</SYSTEM_Data>
        <VIDEO_Data>string</VIDEO_Data>
        <MOTION_Data>string</MOTION_Data>
        <EVENT_Data>string</EVENT_Data>
      </GetVideoPIRConfigurationResult>
    </GetVideoPIRConfigurationResponse>
  </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/GetVideoPIRConfiguration?SessionID=string&DeviceID=string&AdditionalInfo=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"?>
<VideoPIRConfigurationResults xmlns="https://services.alarmnet.com/TC2/">
  <DeviceName>string</DeviceName>
  <FeatureFlags>string</FeatureFlags>
  <SYSTEM_Data>string</SYSTEM_Data>
  <VIDEO_Data>string</VIDEO_Data>
  <MOTION_Data>string</MOTION_Data>
  <EVENT_Data>string</EVENT_Data>
</VideoPIRConfigurationResults>

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

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

<?xml version="1.0" encoding="utf-8"?>
<VideoPIRConfigurationResults xmlns="https://services.alarmnet.com/TC2/">
  <DeviceName>string</DeviceName>
  <FeatureFlags>string</FeatureFlags>
  <SYSTEM_Data>string</SYSTEM_Data>
  <VIDEO_Data>string</VIDEO_Data>
  <MOTION_Data>string</MOTION_Data>
  <EVENT_Data>string</EVENT_Data>
</VideoPIRConfigurationResults>