svcTC2API


Click here for a complete list of operations.

GetConfiguredEventsEx

Get Configured Notification Events at the Given Location.Added notification flags for each module

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

<?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>
    <GetConfiguredEventsEx xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <AdditionalInput>string</AdditionalInput>
    </GetConfiguredEventsEx>
  </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>
    <GetConfiguredEventsExResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetConfiguredEventsExResult>
        <SentToPanelEvents>
          <SentToPanelEvents CustomNotificationMessage="string" NotificationTypeID="int" />
          <SentToPanelEvents CustomNotificationMessage="string" NotificationTypeID="int" />
        </SentToPanelEvents>
        <EventNotifications>
          <EventNotification CustomNotificationMessage="string" NotificationListID="long" ScheduleID="long" SecurityPanelStateCondition="int" NotificationTypeID="int" NotificationDelay="int" NotificationDeadLine="string" />
          <EventNotification CustomNotificationMessage="string" NotificationListID="long" ScheduleID="long" SecurityPanelStateCondition="int" NotificationTypeID="int" NotificationDelay="int" NotificationDeadLine="string" />
        </EventNotifications>
        <SceneTriggers>
          <SceneTrigger SceneID="long" />
          <SceneTrigger SceneID="long" />
        </SceneTriggers>
        <VideoTriggers>
          <VideoTrigger ScheduleID="long" IsEditable="boolean" SecurityPanelStateCondition="int" CameraID="long" CustomNotificationMessage="string" />
          <VideoTrigger ScheduleID="long" IsEditable="boolean" SecurityPanelStateCondition="int" CameraID="long" CustomNotificationMessage="string" />
        </VideoTriggers>
        <TimeTriggeredActions>
          <TimeTriggeredAction DeviceID="long" SceneID="long" EventItemID="long" TriggerTime="string" SelectedDayID="int" IsEnabled="boolean" FlashEventCardType="int" />
          <TimeTriggeredAction DeviceID="long" SceneID="long" EventItemID="long" TriggerTime="string" SelectedDayID="int" IsEnabled="boolean" FlashEventCardType="int" />
        </TimeTriggeredActions>
        <CloudSceneTriggers>
          <CloudSceneTrigger ResponseDeviceID="long" EventNotificationId="long" ResponseModifier1="long" ResponseModifier2="long" DeviceTypeID="int" PartnerID="int" />
          <CloudSceneTrigger ResponseDeviceID="long" EventNotificationId="long" ResponseModifier1="long" ResponseModifier2="long" DeviceTypeID="int" PartnerID="int" />
        </CloudSceneTriggers>
        <Notificationflag>
          <AuditNotification>boolean</AuditNotification>
          <SecuritySystemNotification>boolean</SecuritySystemNotification>
          <VideoNotification>boolean</VideoNotification>
          <GPSNotification>boolean</GPSNotification>
          <AutomationNotification>boolean</AutomationNotification>
          <EmergencyAlertNotification>boolean</EmergencyAlertNotification>
          <WifiDoorBellNotification>boolean</WifiDoorBellNotification>
          <BuiltInCameraNotification>boolean</BuiltInCameraNotification>
        </Notificationflag>
        <NotificationInfo>
          <EventNotificationInfo>
            <EventItemID>long</EventItemID>
            <NotificationName>string</NotificationName>
            <NotificationTypeName>string</NotificationTypeName>
            <SensorName>string</SensorName>
            <ScheduleName>string</ScheduleName>
            <DeviceName>string</DeviceName>
          </EventNotificationInfo>
          <EventNotificationInfo>
            <EventItemID>long</EventItemID>
            <NotificationName>string</NotificationName>
            <NotificationTypeName>string</NotificationTypeName>
            <SensorName>string</SensorName>
            <ScheduleName>string</ScheduleName>
            <DeviceName>string</DeviceName>
          </EventNotificationInfo>
        </NotificationInfo>
      </GetConfiguredEventsExResult>
    </GetConfiguredEventsExResponse>
  </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>
    <GetConfiguredEventsEx xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <AdditionalInput>string</AdditionalInput>
    </GetConfiguredEventsEx>
  </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>
    <GetConfiguredEventsExResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetConfiguredEventsExResult>
        <SentToPanelEvents>
          <SentToPanelEvents CustomNotificationMessage="string" NotificationTypeID="int" />
          <SentToPanelEvents CustomNotificationMessage="string" NotificationTypeID="int" />
        </SentToPanelEvents>
        <EventNotifications>
          <EventNotification CustomNotificationMessage="string" NotificationListID="long" ScheduleID="long" SecurityPanelStateCondition="int" NotificationTypeID="int" NotificationDelay="int" NotificationDeadLine="string" />
          <EventNotification CustomNotificationMessage="string" NotificationListID="long" ScheduleID="long" SecurityPanelStateCondition="int" NotificationTypeID="int" NotificationDelay="int" NotificationDeadLine="string" />
        </EventNotifications>
        <SceneTriggers>
          <SceneTrigger SceneID="long" />
          <SceneTrigger SceneID="long" />
        </SceneTriggers>
        <VideoTriggers>
          <VideoTrigger ScheduleID="long" IsEditable="boolean" SecurityPanelStateCondition="int" CameraID="long" CustomNotificationMessage="string" />
          <VideoTrigger ScheduleID="long" IsEditable="boolean" SecurityPanelStateCondition="int" CameraID="long" CustomNotificationMessage="string" />
        </VideoTriggers>
        <TimeTriggeredActions>
          <TimeTriggeredAction DeviceID="long" SceneID="long" EventItemID="long" TriggerTime="string" SelectedDayID="int" IsEnabled="boolean" FlashEventCardType="int" />
          <TimeTriggeredAction DeviceID="long" SceneID="long" EventItemID="long" TriggerTime="string" SelectedDayID="int" IsEnabled="boolean" FlashEventCardType="int" />
        </TimeTriggeredActions>
        <CloudSceneTriggers>
          <CloudSceneTrigger ResponseDeviceID="long" EventNotificationId="long" ResponseModifier1="long" ResponseModifier2="long" DeviceTypeID="int" PartnerID="int" />
          <CloudSceneTrigger ResponseDeviceID="long" EventNotificationId="long" ResponseModifier1="long" ResponseModifier2="long" DeviceTypeID="int" PartnerID="int" />
        </CloudSceneTriggers>
        <Notificationflag>
          <AuditNotification>boolean</AuditNotification>
          <SecuritySystemNotification>boolean</SecuritySystemNotification>
          <VideoNotification>boolean</VideoNotification>
          <GPSNotification>boolean</GPSNotification>
          <AutomationNotification>boolean</AutomationNotification>
          <EmergencyAlertNotification>boolean</EmergencyAlertNotification>
          <WifiDoorBellNotification>boolean</WifiDoorBellNotification>
          <BuiltInCameraNotification>boolean</BuiltInCameraNotification>
        </Notificationflag>
        <NotificationInfo>
          <EventNotificationInfo>
            <EventItemID>long</EventItemID>
            <NotificationName>string</NotificationName>
            <NotificationTypeName>string</NotificationTypeName>
            <SensorName>string</SensorName>
            <ScheduleName>string</ScheduleName>
            <DeviceName>string</DeviceName>
          </EventNotificationInfo>
          <EventNotificationInfo>
            <EventItemID>long</EventItemID>
            <NotificationName>string</NotificationName>
            <NotificationTypeName>string</NotificationTypeName>
            <SensorName>string</SensorName>
            <ScheduleName>string</ScheduleName>
            <DeviceName>string</DeviceName>
          </EventNotificationInfo>
        </NotificationInfo>
      </GetConfiguredEventsExResult>
    </GetConfiguredEventsExResponse>
  </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/GetConfiguredEventsEx?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"?>
<ConfiguredEventNotificationResult xmlns="https://services.alarmnet.com/TC2/">
  <SentToPanelEvents>
    <SentToPanelEvents CustomNotificationMessage="string" NotificationTypeID="int" />
    <SentToPanelEvents CustomNotificationMessage="string" NotificationTypeID="int" />
  </SentToPanelEvents>
  <EventNotifications>
    <EventNotification CustomNotificationMessage="string" NotificationListID="long" ScheduleID="long" SecurityPanelStateCondition="int" NotificationTypeID="int" NotificationDelay="int" NotificationDeadLine="string" />
    <EventNotification CustomNotificationMessage="string" NotificationListID="long" ScheduleID="long" SecurityPanelStateCondition="int" NotificationTypeID="int" NotificationDelay="int" NotificationDeadLine="string" />
  </EventNotifications>
  <SceneTriggers>
    <SceneTrigger SceneID="long" />
    <SceneTrigger SceneID="long" />
  </SceneTriggers>
  <VideoTriggers>
    <VideoTrigger ScheduleID="long" IsEditable="boolean" SecurityPanelStateCondition="int" CameraID="long" CustomNotificationMessage="string" />
    <VideoTrigger ScheduleID="long" IsEditable="boolean" SecurityPanelStateCondition="int" CameraID="long" CustomNotificationMessage="string" />
  </VideoTriggers>
  <TimeTriggeredActions>
    <TimeTriggeredAction DeviceID="long" SceneID="long" EventItemID="long" TriggerTime="string" SelectedDayID="int" IsEnabled="boolean" FlashEventCardType="int" />
    <TimeTriggeredAction DeviceID="long" SceneID="long" EventItemID="long" TriggerTime="string" SelectedDayID="int" IsEnabled="boolean" FlashEventCardType="int" />
  </TimeTriggeredActions>
  <CloudSceneTriggers>
    <CloudSceneTrigger ResponseDeviceID="long" EventNotificationId="long" ResponseModifier1="long" ResponseModifier2="long" DeviceTypeID="int" PartnerID="int" />
    <CloudSceneTrigger ResponseDeviceID="long" EventNotificationId="long" ResponseModifier1="long" ResponseModifier2="long" DeviceTypeID="int" PartnerID="int" />
  </CloudSceneTriggers>
  <Notificationflag>
    <AuditNotification>boolean</AuditNotification>
    <SecuritySystemNotification>boolean</SecuritySystemNotification>
    <VideoNotification>boolean</VideoNotification>
    <GPSNotification>boolean</GPSNotification>
    <AutomationNotification>boolean</AutomationNotification>
    <EmergencyAlertNotification>boolean</EmergencyAlertNotification>
    <WifiDoorBellNotification>boolean</WifiDoorBellNotification>
    <BuiltInCameraNotification>boolean</BuiltInCameraNotification>
  </Notificationflag>
  <NotificationInfo>
    <EventNotificationInfo>
      <EventItemID>long</EventItemID>
      <NotificationName>string</NotificationName>
      <NotificationTypeName>string</NotificationTypeName>
      <SensorName>string</SensorName>
      <ScheduleName>string</ScheduleName>
      <DeviceName>string</DeviceName>
    </EventNotificationInfo>
    <EventNotificationInfo>
      <EventItemID>long</EventItemID>
      <NotificationName>string</NotificationName>
      <NotificationTypeName>string</NotificationTypeName>
      <SensorName>string</SensorName>
      <ScheduleName>string</ScheduleName>
      <DeviceName>string</DeviceName>
    </EventNotificationInfo>
  </NotificationInfo>
</ConfiguredEventNotificationResult>

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/GetConfiguredEventsEx 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"?>
<ConfiguredEventNotificationResult xmlns="https://services.alarmnet.com/TC2/">
  <SentToPanelEvents>
    <SentToPanelEvents CustomNotificationMessage="string" NotificationTypeID="int" />
    <SentToPanelEvents CustomNotificationMessage="string" NotificationTypeID="int" />
  </SentToPanelEvents>
  <EventNotifications>
    <EventNotification CustomNotificationMessage="string" NotificationListID="long" ScheduleID="long" SecurityPanelStateCondition="int" NotificationTypeID="int" NotificationDelay="int" NotificationDeadLine="string" />
    <EventNotification CustomNotificationMessage="string" NotificationListID="long" ScheduleID="long" SecurityPanelStateCondition="int" NotificationTypeID="int" NotificationDelay="int" NotificationDeadLine="string" />
  </EventNotifications>
  <SceneTriggers>
    <SceneTrigger SceneID="long" />
    <SceneTrigger SceneID="long" />
  </SceneTriggers>
  <VideoTriggers>
    <VideoTrigger ScheduleID="long" IsEditable="boolean" SecurityPanelStateCondition="int" CameraID="long" CustomNotificationMessage="string" />
    <VideoTrigger ScheduleID="long" IsEditable="boolean" SecurityPanelStateCondition="int" CameraID="long" CustomNotificationMessage="string" />
  </VideoTriggers>
  <TimeTriggeredActions>
    <TimeTriggeredAction DeviceID="long" SceneID="long" EventItemID="long" TriggerTime="string" SelectedDayID="int" IsEnabled="boolean" FlashEventCardType="int" />
    <TimeTriggeredAction DeviceID="long" SceneID="long" EventItemID="long" TriggerTime="string" SelectedDayID="int" IsEnabled="boolean" FlashEventCardType="int" />
  </TimeTriggeredActions>
  <CloudSceneTriggers>
    <CloudSceneTrigger ResponseDeviceID="long" EventNotificationId="long" ResponseModifier1="long" ResponseModifier2="long" DeviceTypeID="int" PartnerID="int" />
    <CloudSceneTrigger ResponseDeviceID="long" EventNotificationId="long" ResponseModifier1="long" ResponseModifier2="long" DeviceTypeID="int" PartnerID="int" />
  </CloudSceneTriggers>
  <Notificationflag>
    <AuditNotification>boolean</AuditNotification>
    <SecuritySystemNotification>boolean</SecuritySystemNotification>
    <VideoNotification>boolean</VideoNotification>
    <GPSNotification>boolean</GPSNotification>
    <AutomationNotification>boolean</AutomationNotification>
    <EmergencyAlertNotification>boolean</EmergencyAlertNotification>
    <WifiDoorBellNotification>boolean</WifiDoorBellNotification>
    <BuiltInCameraNotification>boolean</BuiltInCameraNotification>
  </Notificationflag>
  <NotificationInfo>
    <EventNotificationInfo>
      <EventItemID>long</EventItemID>
      <NotificationName>string</NotificationName>
      <NotificationTypeName>string</NotificationTypeName>
      <SensorName>string</SensorName>
      <ScheduleName>string</ScheduleName>
      <DeviceName>string</DeviceName>
    </EventNotificationInfo>
    <EventNotificationInfo>
      <EventItemID>long</EventItemID>
      <NotificationName>string</NotificationName>
      <NotificationTypeName>string</NotificationTypeName>
      <SensorName>string</SensorName>
      <ScheduleName>string</ScheduleName>
      <DeviceName>string</DeviceName>
    </EventNotificationInfo>
  </NotificationInfo>
</ConfiguredEventNotificationResult>