svcTC2API


Click here for a complete list of operations.

GetDoorbellEvents

Returns doorbell event records. A maximum of 100 records can be returned per call.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionId:
LocationId:
DeviceId:
MaxRecords:
EventTypeFilter:
ShowHidden:
StartDateTime:
EndDateTime:
DateFormat:
TimeFormat:
SortOrder:
LastEventIdReceived:

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

<?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>
    <GetDoorbellEvents xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <LocationId>long</LocationId>
      <DeviceId>long</DeviceId>
      <MaxRecords>short</MaxRecords>
      <EventTypeFilter>long</EventTypeFilter>
      <ShowHidden>boolean</ShowHidden>
      <StartDateTime>string</StartDateTime>
      <EndDateTime>string</EndDateTime>
      <DateFormat>short</DateFormat>
      <TimeFormat>short</TimeFormat>
      <SortOrder>int</SortOrder>
      <LastEventIdReceived>long</LastEventIdReceived>
    </GetDoorbellEvents>
  </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>
    <GetDoorbellEventsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetDoorbellEventsResult>
        <DoorbellEvents>
          <DoorbellEventRecord>
            <ThumbnailURL>string</ThumbnailURL>
            <State>string</State>
          </DoorbellEventRecord>
          <DoorbellEventRecord>
            <ThumbnailURL>string</ThumbnailURL>
            <State>string</State>
          </DoorbellEventRecord>
        </DoorbellEvents>
        <HasMore>boolean</HasMore>
      </GetDoorbellEventsResult>
    </GetDoorbellEventsResponse>
  </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>
    <GetDoorbellEvents xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <LocationId>long</LocationId>
      <DeviceId>long</DeviceId>
      <MaxRecords>short</MaxRecords>
      <EventTypeFilter>long</EventTypeFilter>
      <ShowHidden>boolean</ShowHidden>
      <StartDateTime>string</StartDateTime>
      <EndDateTime>string</EndDateTime>
      <DateFormat>short</DateFormat>
      <TimeFormat>short</TimeFormat>
      <SortOrder>int</SortOrder>
      <LastEventIdReceived>long</LastEventIdReceived>
    </GetDoorbellEvents>
  </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>
    <GetDoorbellEventsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetDoorbellEventsResult>
        <DoorbellEvents>
          <DoorbellEventRecord>
            <ThumbnailURL>string</ThumbnailURL>
            <State>string</State>
          </DoorbellEventRecord>
          <DoorbellEventRecord>
            <ThumbnailURL>string</ThumbnailURL>
            <State>string</State>
          </DoorbellEventRecord>
        </DoorbellEvents>
        <HasMore>boolean</HasMore>
      </GetDoorbellEventsResult>
    </GetDoorbellEventsResponse>
  </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/GetDoorbellEvents?SessionId=string&LocationId=string&DeviceId=string&MaxRecords=string&EventTypeFilter=string&ShowHidden=string&StartDateTime=string&EndDateTime=string&DateFormat=string&TimeFormat=string&SortOrder=string&LastEventIdReceived=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"?>
<DoorbellEventsResult xmlns="https://services.alarmnet.com/TC2/">
  <DoorbellEvents>
    <DoorbellEventRecord>
      <ThumbnailURL>string</ThumbnailURL>
      <State>string</State>
    </DoorbellEventRecord>
    <DoorbellEventRecord>
      <ThumbnailURL>string</ThumbnailURL>
      <State>string</State>
    </DoorbellEventRecord>
  </DoorbellEvents>
  <HasMore>boolean</HasMore>
</DoorbellEventsResult>

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

SessionId=string&LocationId=string&DeviceId=string&MaxRecords=string&EventTypeFilter=string&ShowHidden=string&StartDateTime=string&EndDateTime=string&DateFormat=string&TimeFormat=string&SortOrder=string&LastEventIdReceived=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<DoorbellEventsResult xmlns="https://services.alarmnet.com/TC2/">
  <DoorbellEvents>
    <DoorbellEventRecord>
      <ThumbnailURL>string</ThumbnailURL>
      <State>string</State>
    </DoorbellEventRecord>
    <DoorbellEventRecord>
      <ThumbnailURL>string</ThumbnailURL>
      <State>string</State>
    </DoorbellEventRecord>
  </DoorbellEvents>
  <HasMore>boolean</HasMore>
</DoorbellEventsResult>