svcTC2API Web Service

svcTC2API

Click here for a complete list of operations.

GetLiveEvents

Returns a set of device event records. A maximum of 250 records can be returned per call. The parameter LastEventIdReceived is used to retreive newer records than the ones previously obtained. Entering the most recent event id into this field will return all records that are newer than that record

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
SessionId:
LocationId:
LastEventIdReceived:
MaxRecords:
DateFormat:
TimeFormat:

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

<?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>
    <GetLiveEvents xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <LocationId>long</LocationId>
      <LastEventIdReceived>long</LastEventIdReceived>
      <MaxRecords>short</MaxRecords>
      <DateFormat>short</DateFormat>
      <TimeFormat>short</TimeFormat>
    </GetLiveEvents>
  </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>
    <GetLiveEventsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetLiveEventsResult>
        <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>
      </GetLiveEventsResult>
    </GetLiveEventsResponse>
  </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>
    <GetLiveEvents xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <LocationId>long</LocationId>
      <LastEventIdReceived>long</LastEventIdReceived>
      <MaxRecords>short</MaxRecords>
      <DateFormat>short</DateFormat>
      <TimeFormat>short</TimeFormat>
    </GetLiveEvents>
  </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>
    <GetLiveEventsResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetLiveEventsResult>
        <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>
      </GetLiveEventsResult>
    </GetLiveEventsResponse>
  </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/GetLiveEvents?SessionId=string&LocationId=string&LastEventIdReceived=string&MaxRecords=string&DateFormat=string&TimeFormat=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/GetLiveEvents HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionId=string&LocationId=string&LastEventIdReceived=string&MaxRecords=string&DateFormat=string&TimeFormat=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>