svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

GetEventsEx_V1

Returns a set of device or audit event records. A maximum of 100 records can be returned per call.Eevnts by partition

Test

The test form is only available for requests from the local machine.

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

<?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>
    <GetEventsEx_V1 xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <FilterClass>short</FilterClass>
      <LocationId>long</LocationId>
      <DeviceId>long</DeviceId>
      <MaxRecords>short</MaxRecords>
      <EventTypeFilterList>
        <int>int</int>
        <int>int</int>
      </EventTypeFilterList>
      <ShowHidden>boolean</ShowHidden>
      <ShowLocked>boolean</ShowLocked>
      <StartDateTime>string</StartDateTime>
      <EndDateTime>string</EndDateTime>
      <DateFormat>short</DateFormat>
      <TimeFormat>short</TimeFormat>
      <SortOrder>int</SortOrder>
      <LastEventIdReceived>long</LastEventIdReceived>
      <PartitionID>
        <int>int</int>
        <int>int</int>
      </PartitionID>
    </GetEventsEx_V1>
  </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>
    <GetEventsEx_V1Response xmlns="https://services.alarmnet.com/TC2/">
      <GetEventsEx_V1Result>
        <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>
      </GetEventsEx_V1Result>
    </GetEventsEx_V1Response>
  </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>
    <GetEventsEx_V1 xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <FilterClass>short</FilterClass>
      <LocationId>long</LocationId>
      <DeviceId>long</DeviceId>
      <MaxRecords>short</MaxRecords>
      <EventTypeFilterList>
        <int>int</int>
        <int>int</int>
      </EventTypeFilterList>
      <ShowHidden>boolean</ShowHidden>
      <ShowLocked>boolean</ShowLocked>
      <StartDateTime>string</StartDateTime>
      <EndDateTime>string</EndDateTime>
      <DateFormat>short</DateFormat>
      <TimeFormat>short</TimeFormat>
      <SortOrder>int</SortOrder>
      <LastEventIdReceived>long</LastEventIdReceived>
      <PartitionID>
        <int>int</int>
        <int>int</int>
      </PartitionID>
    </GetEventsEx_V1>
  </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>
    <GetEventsEx_V1Response xmlns="https://services.alarmnet.com/TC2/">
      <GetEventsEx_V1Result>
        <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>
      </GetEventsEx_V1Result>
    </GetEventsEx_V1Response>
  </soap12:Body>
</soap12:Envelope>