svcTC2API


Click here for a complete list of operations.

GetEvents

Returns a set of device or audit 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:
FilterClass:
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/GetEvents"

<?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>
    <GetEvents xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <FilterClass>short</FilterClass>
      <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>
    </GetEvents>
  </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>
    <GetEventsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetEventsResult>
        <Events>
          <EventRecord>
            <EventRecordId>long</EventRecordId>
            <EventType>long</EventType>
            <Event>string</Event>
            <Originator>string</Originator>
            <Notice>string</Notice>
            <Notes>string</Notes>
            <HasNotes>boolean</HasNotes>
            <IsLocked>boolean</IsLocked>
            <IsHidden>boolean</IsHidden>
            <RecDateTimeGMT>string</RecDateTimeGMT>
            <RecDateLocal>string</RecDateLocal>
            <RecDateSuffix>string</RecDateSuffix>
            <FilterClass>int</FilterClass>
            <DeviceId>long</DeviceId>
            <EventFilterTypeID>long</EventFilterTypeID>
            <MediaId>string</MediaId>
            <Viewed>short</Viewed>
            <PanelEventId>long</PanelEventId>
          </EventRecord>
          <EventRecord>
            <EventRecordId>long</EventRecordId>
            <EventType>long</EventType>
            <Event>string</Event>
            <Originator>string</Originator>
            <Notice>string</Notice>
            <Notes>string</Notes>
            <HasNotes>boolean</HasNotes>
            <IsLocked>boolean</IsLocked>
            <IsHidden>boolean</IsHidden>
            <RecDateTimeGMT>string</RecDateTimeGMT>
            <RecDateLocal>string</RecDateLocal>
            <RecDateSuffix>string</RecDateSuffix>
            <FilterClass>int</FilterClass>
            <DeviceId>long</DeviceId>
            <EventFilterTypeID>long</EventFilterTypeID>
            <MediaId>string</MediaId>
            <Viewed>short</Viewed>
            <PanelEventId>long</PanelEventId>
          </EventRecord>
        </Events>
        <HasMore>boolean</HasMore>
      </GetEventsResult>
    </GetEventsResponse>
  </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>
    <GetEvents xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <FilterClass>short</FilterClass>
      <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>
    </GetEvents>
  </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>
    <GetEventsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetEventsResult>
        <Events>
          <EventRecord>
            <EventRecordId>long</EventRecordId>
            <EventType>long</EventType>
            <Event>string</Event>
            <Originator>string</Originator>
            <Notice>string</Notice>
            <Notes>string</Notes>
            <HasNotes>boolean</HasNotes>
            <IsLocked>boolean</IsLocked>
            <IsHidden>boolean</IsHidden>
            <RecDateTimeGMT>string</RecDateTimeGMT>
            <RecDateLocal>string</RecDateLocal>
            <RecDateSuffix>string</RecDateSuffix>
            <FilterClass>int</FilterClass>
            <DeviceId>long</DeviceId>
            <EventFilterTypeID>long</EventFilterTypeID>
            <MediaId>string</MediaId>
            <Viewed>short</Viewed>
            <PanelEventId>long</PanelEventId>
          </EventRecord>
          <EventRecord>
            <EventRecordId>long</EventRecordId>
            <EventType>long</EventType>
            <Event>string</Event>
            <Originator>string</Originator>
            <Notice>string</Notice>
            <Notes>string</Notes>
            <HasNotes>boolean</HasNotes>
            <IsLocked>boolean</IsLocked>
            <IsHidden>boolean</IsHidden>
            <RecDateTimeGMT>string</RecDateTimeGMT>
            <RecDateLocal>string</RecDateLocal>
            <RecDateSuffix>string</RecDateSuffix>
            <FilterClass>int</FilterClass>
            <DeviceId>long</DeviceId>
            <EventFilterTypeID>long</EventFilterTypeID>
            <MediaId>string</MediaId>
            <Viewed>short</Viewed>
            <PanelEventId>long</PanelEventId>
          </EventRecord>
        </Events>
        <HasMore>boolean</HasMore>
      </GetEventsResult>
    </GetEventsResponse>
  </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/GetEvents?SessionId=string&FilterClass=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"?>
<EventsResult xmlns="https://services.alarmnet.com/TC2/">
  <Events>
    <EventRecord>
      <EventRecordId>long</EventRecordId>
      <EventType>long</EventType>
      <Event>string</Event>
      <Originator>string</Originator>
      <Notice>string</Notice>
      <Notes>string</Notes>
      <HasNotes>boolean</HasNotes>
      <IsLocked>boolean</IsLocked>
      <IsHidden>boolean</IsHidden>
      <RecDateTimeGMT>string</RecDateTimeGMT>
      <RecDateLocal>string</RecDateLocal>
      <RecDateSuffix>string</RecDateSuffix>
      <FilterClass>int</FilterClass>
      <DeviceId>long</DeviceId>
      <EventFilterTypeID>long</EventFilterTypeID>
      <MediaId>string</MediaId>
      <Viewed>short</Viewed>
      <PanelEventId>long</PanelEventId>
    </EventRecord>
    <EventRecord>
      <EventRecordId>long</EventRecordId>
      <EventType>long</EventType>
      <Event>string</Event>
      <Originator>string</Originator>
      <Notice>string</Notice>
      <Notes>string</Notes>
      <HasNotes>boolean</HasNotes>
      <IsLocked>boolean</IsLocked>
      <IsHidden>boolean</IsHidden>
      <RecDateTimeGMT>string</RecDateTimeGMT>
      <RecDateLocal>string</RecDateLocal>
      <RecDateSuffix>string</RecDateSuffix>
      <FilterClass>int</FilterClass>
      <DeviceId>long</DeviceId>
      <EventFilterTypeID>long</EventFilterTypeID>
      <MediaId>string</MediaId>
      <Viewed>short</Viewed>
      <PanelEventId>long</PanelEventId>
    </EventRecord>
  </Events>
  <HasMore>boolean</HasMore>
</EventsResult>

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

SessionId=string&FilterClass=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"?>
<EventsResult xmlns="https://services.alarmnet.com/TC2/">
  <Events>
    <EventRecord>
      <EventRecordId>long</EventRecordId>
      <EventType>long</EventType>
      <Event>string</Event>
      <Originator>string</Originator>
      <Notice>string</Notice>
      <Notes>string</Notes>
      <HasNotes>boolean</HasNotes>
      <IsLocked>boolean</IsLocked>
      <IsHidden>boolean</IsHidden>
      <RecDateTimeGMT>string</RecDateTimeGMT>
      <RecDateLocal>string</RecDateLocal>
      <RecDateSuffix>string</RecDateSuffix>
      <FilterClass>int</FilterClass>
      <DeviceId>long</DeviceId>
      <EventFilterTypeID>long</EventFilterTypeID>
      <MediaId>string</MediaId>
      <Viewed>short</Viewed>
      <PanelEventId>long</PanelEventId>
    </EventRecord>
    <EventRecord>
      <EventRecordId>long</EventRecordId>
      <EventType>long</EventType>
      <Event>string</Event>
      <Originator>string</Originator>
      <Notice>string</Notice>
      <Notes>string</Notes>
      <HasNotes>boolean</HasNotes>
      <IsLocked>boolean</IsLocked>
      <IsHidden>boolean</IsHidden>
      <RecDateTimeGMT>string</RecDateTimeGMT>
      <RecDateLocal>string</RecDateLocal>
      <RecDateSuffix>string</RecDateSuffix>
      <FilterClass>int</FilterClass>
      <DeviceId>long</DeviceId>
      <EventFilterTypeID>long</EventFilterTypeID>
      <MediaId>string</MediaId>
      <Viewed>short</Viewed>
      <PanelEventId>long</PanelEventId>
    </EventRecord>
  </Events>
  <HasMore>boolean</HasMore>
</EventsResult>