svcTC2API


Click here for a complete list of operations.

TakeVideoPIRSnapshots

Trigger the Peek In Now Action for VideoPIR.

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

<?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>
    <TakeVideoPIRSnapshots xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <AdditionalInfo>string</AdditionalInfo>
    </TakeVideoPIRSnapshots>
  </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>
    <TakeVideoPIRSnapshotsResponse xmlns="https://services.alarmnet.com/TC2/">
      <TakeVideoPIRSnapshotsResult>
        <ResultCode>int</ResultCode>
        <ResultData>string</ResultData>
      </TakeVideoPIRSnapshotsResult>
    </TakeVideoPIRSnapshotsResponse>
  </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>
    <TakeVideoPIRSnapshots xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <DeviceID>long</DeviceID>
      <AdditionalInfo>string</AdditionalInfo>
    </TakeVideoPIRSnapshots>
  </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>
    <TakeVideoPIRSnapshotsResponse xmlns="https://services.alarmnet.com/TC2/">
      <TakeVideoPIRSnapshotsResult>
        <ResultCode>int</ResultCode>
        <ResultData>string</ResultData>
      </TakeVideoPIRSnapshotsResult>
    </TakeVideoPIRSnapshotsResponse>
  </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/TakeVideoPIRSnapshots?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"?>
<WebMethodResults xmlns="https://services.alarmnet.com/TC2/">
  <ResultCode>int</ResultCode>
  <ResultData>string</ResultData>
</WebMethodResults>

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/TakeVideoPIRSnapshots 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"?>
<WebMethodResults xmlns="https://services.alarmnet.com/TC2/">
  <ResultCode>int</ResultCode>
  <ResultData>string</ResultData>
</WebMethodResults>