svcTC2API


Click here for a complete list of operations.

GetEventSummaryXML

Get Summary of Configured Notification Events in XML at the Given Location.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
LocationID:
AdditionalInput:

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

<?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>
    <GetEventSummaryXML xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <AdditionalInput>string</AdditionalInput>
    </GetEventSummaryXML>
  </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>
    <GetEventSummaryXMLResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetEventSummaryXMLResult>
        <EventSummaryTitle>
          <LocationName>string</LocationName>
          <LocationTime>string</LocationTime>
        </EventSummaryTitle>
        <SummaryEvents>
          <EventSummaryConfigured EventTypeDescription="string" EventGroupName="string" EventClassDescription="string" CustomNotificationMessage="string" IsEnabled="boolean" NotificationListName="string" NotificationScheduleName="string" TriggerType="string" Trigger="string" Notes="string" />
          <EventSummaryConfigured EventTypeDescription="string" EventGroupName="string" EventClassDescription="string" CustomNotificationMessage="string" IsEnabled="boolean" NotificationListName="string" NotificationScheduleName="string" TriggerType="string" Trigger="string" Notes="string" />
        </SummaryEvents>
        <SummaryTTEvents>
          <EventSummaryTimeTriggeredActions EventGroupName="string" EventTypeDescription="string" SceneName="string" TriggerType="string">
            <Notes>string</Notes>
          </EventSummaryTimeTriggeredActions>
          <EventSummaryTimeTriggeredActions EventGroupName="string" EventTypeDescription="string" SceneName="string" TriggerType="string">
            <Notes>string</Notes>
          </EventSummaryTimeTriggeredActions>
        </SummaryTTEvents>
      </GetEventSummaryXMLResult>
    </GetEventSummaryXMLResponse>
  </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>
    <GetEventSummaryXML xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <AdditionalInput>string</AdditionalInput>
    </GetEventSummaryXML>
  </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>
    <GetEventSummaryXMLResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetEventSummaryXMLResult>
        <EventSummaryTitle>
          <LocationName>string</LocationName>
          <LocationTime>string</LocationTime>
        </EventSummaryTitle>
        <SummaryEvents>
          <EventSummaryConfigured EventTypeDescription="string" EventGroupName="string" EventClassDescription="string" CustomNotificationMessage="string" IsEnabled="boolean" NotificationListName="string" NotificationScheduleName="string" TriggerType="string" Trigger="string" Notes="string" />
          <EventSummaryConfigured EventTypeDescription="string" EventGroupName="string" EventClassDescription="string" CustomNotificationMessage="string" IsEnabled="boolean" NotificationListName="string" NotificationScheduleName="string" TriggerType="string" Trigger="string" Notes="string" />
        </SummaryEvents>
        <SummaryTTEvents>
          <EventSummaryTimeTriggeredActions EventGroupName="string" EventTypeDescription="string" SceneName="string" TriggerType="string">
            <Notes>string</Notes>
          </EventSummaryTimeTriggeredActions>
          <EventSummaryTimeTriggeredActions EventGroupName="string" EventTypeDescription="string" SceneName="string" TriggerType="string">
            <Notes>string</Notes>
          </EventSummaryTimeTriggeredActions>
        </SummaryTTEvents>
      </GetEventSummaryXMLResult>
    </GetEventSummaryXMLResponse>
  </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/GetEventSummaryXML?SessionID=string&LocationID=string&AdditionalInput=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"?>
<SummaryConfiguredEventXML xmlns="https://services.alarmnet.com/TC2/">
  <EventSummaryTitle>
    <LocationName>string</LocationName>
    <LocationTime>string</LocationTime>
  </EventSummaryTitle>
  <SummaryEvents>
    <EventSummaryConfigured EventTypeDescription="string" EventGroupName="string" EventClassDescription="string" CustomNotificationMessage="string" IsEnabled="boolean" NotificationListName="string" NotificationScheduleName="string" TriggerType="string" Trigger="string" Notes="string" />
    <EventSummaryConfigured EventTypeDescription="string" EventGroupName="string" EventClassDescription="string" CustomNotificationMessage="string" IsEnabled="boolean" NotificationListName="string" NotificationScheduleName="string" TriggerType="string" Trigger="string" Notes="string" />
  </SummaryEvents>
  <SummaryTTEvents>
    <EventSummaryTimeTriggeredActions EventGroupName="string" EventTypeDescription="string" SceneName="string" TriggerType="string">
      <Notes>string</Notes>
    </EventSummaryTimeTriggeredActions>
    <EventSummaryTimeTriggeredActions EventGroupName="string" EventTypeDescription="string" SceneName="string" TriggerType="string">
      <Notes>string</Notes>
    </EventSummaryTimeTriggeredActions>
  </SummaryTTEvents>
</SummaryConfiguredEventXML>

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

SessionID=string&LocationID=string&AdditionalInput=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SummaryConfiguredEventXML xmlns="https://services.alarmnet.com/TC2/">
  <EventSummaryTitle>
    <LocationName>string</LocationName>
    <LocationTime>string</LocationTime>
  </EventSummaryTitle>
  <SummaryEvents>
    <EventSummaryConfigured EventTypeDescription="string" EventGroupName="string" EventClassDescription="string" CustomNotificationMessage="string" IsEnabled="boolean" NotificationListName="string" NotificationScheduleName="string" TriggerType="string" Trigger="string" Notes="string" />
    <EventSummaryConfigured EventTypeDescription="string" EventGroupName="string" EventClassDescription="string" CustomNotificationMessage="string" IsEnabled="boolean" NotificationListName="string" NotificationScheduleName="string" TriggerType="string" Trigger="string" Notes="string" />
  </SummaryEvents>
  <SummaryTTEvents>
    <EventSummaryTimeTriggeredActions EventGroupName="string" EventTypeDescription="string" SceneName="string" TriggerType="string">
      <Notes>string</Notes>
    </EventSummaryTimeTriggeredActions>
    <EventSummaryTimeTriggeredActions EventGroupName="string" EventTypeDescription="string" SceneName="string" TriggerType="string">
      <Notes>string</Notes>
    </EventSummaryTimeTriggeredActions>
  </SummaryTTEvents>
</SummaryConfiguredEventXML>