GET api/v1/eventSummaryXML/locations/{locationId}?additionalInput={additionalInput}

Get Summary of Configured Notification Events in XML at the Given Location. Equivalent SOAP API: GetEventSummaryXML

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	Location ID	integer	Required
additionalInput	additionalInput	string	None.

Body Parameters

None.

Response Information

Resource Description

SummaryConfiguredEventXML

Name	Type	Additional information
EventSummaryTitle	EventSummaryTitle	None.
SummaryEvents	Collection of EventSummaryConfigured	None.
SummaryTTEvents	Collection of EventSummaryTimeTriggeredActions	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:

<SummaryConfiguredEventXML xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <EventSummaryTitle xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
    <d2p1:LocationName>sample string 1</d2p1:LocationName>
    <d2p1:LocationTime>sample string 2</d2p1:LocationTime>
  </EventSummaryTitle>
  <SummaryEvents xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
    <d2p1:EventSummaryConfigured>
      <d2p1:CameraID>26</d2p1:CameraID>
      <d2p1:CameraName>sample string 27</d2p1:CameraName>
      <d2p1:CustomNotificationMessage>sample string 9</d2p1:CustomNotificationMessage>
      <d2p1:DayID>16</d2p1:DayID>
      <d2p1:DeviceID>24</d2p1:DeviceID>
      <d2p1:DeviceName>sample string 25</d2p1:DeviceName>
      <d2p1:EndTime>sample string 18</d2p1:EndTime>
      <d2p1:EventClassDescription>sample string 8</d2p1:EventClassDescription>
      <d2p1:EventClassID>7</d2p1:EventClassID>
      <d2p1:EventGroupID>5</d2p1:EventGroupID>
      <d2p1:EventGroupName>sample string 6</d2p1:EventGroupName>
      <d2p1:EventItemID>2</d2p1:EventItemID>
      <d2p1:EventTypeDescription>sample string 4</d2p1:EventTypeDescription>
      <d2p1:EventTypeID>3</d2p1:EventTypeID>
      <d2p1:IsEnabled>true</d2p1:IsEnabled>
      <d2p1:IsNotificationListEnabled>true</d2p1:IsNotificationListEnabled>
      <d2p1:IsSceneEnabled>true</d2p1:IsSceneEnabled>
      <d2p1:Notes>sample string 28</d2p1:Notes>
      <d2p1:NotificationListID>11</d2p1:NotificationListID>
      <d2p1:NotificationListName>sample string 12</d2p1:NotificationListName>
      <d2p1:NotificationScheduleID>14</d2p1:NotificationScheduleID>
      <d2p1:NotificationScheduleName>sample string 15</d2p1:NotificationScheduleName>
      <d2p1:SceneID>19</d2p1:SceneID>
      <d2p1:SceneName>sample string 20</d2p1:SceneName>
      <d2p1:SecurityPanelStateCondition>1</d2p1:SecurityPanelStateCondition>
      <d2p1:StartTime>sample string 17</d2p1:StartTime>
      <d2p1:Trigger>sample string 23</d2p1:Trigger>
      <d2p1:TriggerType>sample string 22</d2p1:TriggerType>
    </d2p1:EventSummaryConfigured>
    <d2p1:EventSummaryConfigured>
      <d2p1:CameraID>26</d2p1:CameraID>
      <d2p1:CameraName>sample string 27</d2p1:CameraName>
      <d2p1:CustomNotificationMessage>sample string 9</d2p1:CustomNotificationMessage>
      <d2p1:DayID>16</d2p1:DayID>
      <d2p1:DeviceID>24</d2p1:DeviceID>
      <d2p1:DeviceName>sample string 25</d2p1:DeviceName>
      <d2p1:EndTime>sample string 18</d2p1:EndTime>
      <d2p1:EventClassDescription>sample string 8</d2p1:EventClassDescription>
      <d2p1:EventClassID>7</d2p1:EventClassID>
      <d2p1:EventGroupID>5</d2p1:EventGroupID>
      <d2p1:EventGroupName>sample string 6</d2p1:EventGroupName>
      <d2p1:EventItemID>2</d2p1:EventItemID>
      <d2p1:EventTypeDescription>sample string 4</d2p1:EventTypeDescription>
      <d2p1:EventTypeID>3</d2p1:EventTypeID>
      <d2p1:IsEnabled>true</d2p1:IsEnabled>
      <d2p1:IsNotificationListEnabled>true</d2p1:IsNotificationListEnabled>
      <d2p1:IsSceneEnabled>true</d2p1:IsSceneEnabled>
      <d2p1:Notes>sample string 28</d2p1:Notes>
      <d2p1:NotificationListID>11</d2p1:NotificationListID>
      <d2p1:NotificationListName>sample string 12</d2p1:NotificationListName>
      <d2p1:NotificationScheduleID>14</d2p1:NotificationScheduleID>
      <d2p1:NotificationScheduleName>sample string 15</d2p1:NotificationScheduleName>
      <d2p1:SceneID>19</d2p1:SceneID>
      <d2p1:SceneName>sample string 20</d2p1:SceneName>
      <d2p1:SecurityPanelStateCondition>1</d2p1:SecurityPanelStateCondition>
      <d2p1:StartTime>sample string 17</d2p1:StartTime>
      <d2p1:Trigger>sample string 23</d2p1:Trigger>
      <d2p1:TriggerType>sample string 22</d2p1:TriggerType>
    </d2p1:EventSummaryConfigured>
  </SummaryEvents>
  <SummaryTTEvents xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration">
    <d2p1:EventSummaryTimeTriggeredActions>
      <d2p1:DeviceID>12</d2p1:DeviceID>
      <d2p1:EventClassID>4</d2p1:EventClassID>
      <d2p1:EventGroupID>3</d2p1:EventGroupID>
      <d2p1:EventGroupName>sample string 5</d2p1:EventGroupName>
      <d2p1:EventItemID>1</d2p1:EventItemID>
      <d2p1:EventTypeDescription>sample string 6</d2p1:EventTypeDescription>
      <d2p1:EventTypeID>2</d2p1:EventTypeID>
      <d2p1:IsSceneEnabled>true</d2p1:IsSceneEnabled>
      <d2p1:Notes>sample string 13</d2p1:Notes>
      <d2p1:SceneID>7</d2p1:SceneID>
      <d2p1:SceneName>sample string 8</d2p1:SceneName>
      <d2p1:Trigger>sample string 11</d2p1:Trigger>
      <d2p1:TriggerType>sample string 10</d2p1:TriggerType>
    </d2p1:EventSummaryTimeTriggeredActions>
    <d2p1:EventSummaryTimeTriggeredActions>
      <d2p1:DeviceID>12</d2p1:DeviceID>
      <d2p1:EventClassID>4</d2p1:EventClassID>
      <d2p1:EventGroupID>3</d2p1:EventGroupID>
      <d2p1:EventGroupName>sample string 5</d2p1:EventGroupName>
      <d2p1:EventItemID>1</d2p1:EventItemID>
      <d2p1:EventTypeDescription>sample string 6</d2p1:EventTypeDescription>
      <d2p1:EventTypeID>2</d2p1:EventTypeID>
      <d2p1:IsSceneEnabled>true</d2p1:IsSceneEnabled>
      <d2p1:Notes>sample string 13</d2p1:Notes>
      <d2p1:SceneID>7</d2p1:SceneID>
      <d2p1:SceneName>sample string 8</d2p1:SceneName>
      <d2p1:Trigger>sample string 11</d2p1:Trigger>
      <d2p1:TriggerType>sample string 10</d2p1:TriggerType>
    </d2p1:EventSummaryTimeTriggeredActions>
  </SummaryTTEvents>
</SummaryConfiguredEventXML>