svcTC2API


Click here for a complete list of operations.

GetVideoPIRDeviceEvents

Get VideoPIR device events with applied filter condition

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
DeviceID:
EventID:
DateStamp:
CaptureFilterTypeID:
ShowHidden:
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/GetVideoPIRDeviceEvents"

<?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>
    <GetVideoPIRDeviceEvents xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <EventID>long</EventID>
      <DateStamp>long</DateStamp>
      <CaptureFilterTypeID>int</CaptureFilterTypeID>
      <ShowHidden>int</ShowHidden>
      <AdditionalInfo>string</AdditionalInfo>
    </GetVideoPIRDeviceEvents>
  </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>
    <GetVideoPIRDeviceEventsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetVideoPIRDeviceEventsResult>
        <DeviceEventInfo>
          <DeviceName>string</DeviceName>
          <EventInfo>
            <VideoPIREvent xsi:nil="true" />
            <VideoPIREvent xsi:nil="true" />
          </EventInfo>
          <RemainingImageCount>int</RemainingImageCount>
        </DeviceEventInfo>
      </GetVideoPIRDeviceEventsResult>
    </GetVideoPIRDeviceEventsResponse>
  </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>
    <GetVideoPIRDeviceEvents xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <EventID>long</EventID>
      <DateStamp>long</DateStamp>
      <CaptureFilterTypeID>int</CaptureFilterTypeID>
      <ShowHidden>int</ShowHidden>
      <AdditionalInfo>string</AdditionalInfo>
    </GetVideoPIRDeviceEvents>
  </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>
    <GetVideoPIRDeviceEventsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetVideoPIRDeviceEventsResult>
        <DeviceEventInfo>
          <DeviceName>string</DeviceName>
          <EventInfo>
            <VideoPIREvent xsi:nil="true" />
            <VideoPIREvent xsi:nil="true" />
          </EventInfo>
          <RemainingImageCount>int</RemainingImageCount>
        </DeviceEventInfo>
      </GetVideoPIRDeviceEventsResult>
    </GetVideoPIRDeviceEventsResponse>
  </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/GetVideoPIRDeviceEvents?SessionID=string&DeviceID=string&EventID=string&DateStamp=string&CaptureFilterTypeID=string&ShowHidden=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"?>
<GetVideoPIRDeviceEventsResults xmlns="https://services.alarmnet.com/TC2/">
  <DeviceEventInfo>
    <DeviceName>string</DeviceName>
    <EventInfo>
      <VideoPIREvent>
        <EventID>long</EventID>
        <ImageURL>string</ImageURL>
        <EventImageCount>int</EventImageCount>
        <ImageDateTime>dateTime</ImageDateTime>
        <ImageDateTimeUTC>dateTime</ImageDateTimeUTC>
        <CaptureTypeID>int</CaptureTypeID>
        <ImageRequestID>string</ImageRequestID>
        <TMSMediaID>string</TMSMediaID>
      </VideoPIREvent>
      <VideoPIREvent>
        <EventID>long</EventID>
        <ImageURL>string</ImageURL>
        <EventImageCount>int</EventImageCount>
        <ImageDateTime>dateTime</ImageDateTime>
        <ImageDateTimeUTC>dateTime</ImageDateTimeUTC>
        <CaptureTypeID>int</CaptureTypeID>
        <ImageRequestID>string</ImageRequestID>
        <TMSMediaID>string</TMSMediaID>
      </VideoPIREvent>
    </EventInfo>
    <RemainingImageCount>int</RemainingImageCount>
  </DeviceEventInfo>
</GetVideoPIRDeviceEventsResults>

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

SessionID=string&DeviceID=string&EventID=string&DateStamp=string&CaptureFilterTypeID=string&ShowHidden=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"?>
<GetVideoPIRDeviceEventsResults xmlns="https://services.alarmnet.com/TC2/">
  <DeviceEventInfo>
    <DeviceName>string</DeviceName>
    <EventInfo>
      <VideoPIREvent>
        <EventID>long</EventID>
        <ImageURL>string</ImageURL>
        <EventImageCount>int</EventImageCount>
        <ImageDateTime>dateTime</ImageDateTime>
        <ImageDateTimeUTC>dateTime</ImageDateTimeUTC>
        <CaptureTypeID>int</CaptureTypeID>
        <ImageRequestID>string</ImageRequestID>
        <TMSMediaID>string</TMSMediaID>
      </VideoPIREvent>
      <VideoPIREvent>
        <EventID>long</EventID>
        <ImageURL>string</ImageURL>
        <EventImageCount>int</EventImageCount>
        <ImageDateTime>dateTime</ImageDateTime>
        <ImageDateTimeUTC>dateTime</ImageDateTimeUTC>
        <CaptureTypeID>int</CaptureTypeID>
        <ImageRequestID>string</ImageRequestID>
        <TMSMediaID>string</TMSMediaID>
      </VideoPIREvent>
    </EventInfo>
    <RemainingImageCount>int</RemainingImageCount>
  </DeviceEventInfo>
</GetVideoPIRDeviceEventsResults>