POST api/v1/account/location/{locationId}/eventItem/{eventItemId}
Add new event notification for this location.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
locationId |
Location ID |
integer |
Required |
eventItemId | integer |
Required |
Body Parameters
Event Details
NewEventInfoName | Description | Type | Additional information |
---|---|---|---|
SentToPanelEvents | Collection of SentToPanelEvents |
None. |
|
EventNotification | Collection of EventNotification |
None. |
|
SceneTriggers | Collection of SceneTrigger |
None. |
|
VideoTriggers | Collection of VideoTrigger |
None. |
|
TimeTriggeredActions | Collection of TimeTriggeredAction |
None. |
|
CloudSceneTriggers | Collection of CloudSceneTrigger |
None. |
Request Formats
application/json, text/json
Sample:
{ "SentToPanelEvents": [ { "CustomNotificationMessage": "sample string 1", "NotificationTypeID": 2, "EventTypeID": 3, "EventItemID": 4, "EventModifierID": 5, "DeviceID": 6, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 13 }, { "CustomNotificationMessage": "sample string 1", "NotificationTypeID": 2, "EventTypeID": 3, "EventItemID": 4, "EventModifierID": 5, "DeviceID": 6, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 13 } ], "EventNotification": [ { "GroupID": "sample string 1", "CustomNotificationMessage": "sample string 2", "NotificationListID": 3, "ScheduleID": 4, "SecurityPanelStateCondition": 5, "NotificationTypeID": 6, "NotificationDelay": 7, "NotificationDeadLine": "sample string 8", "EventTypeID": 9, "EventItemID": 10, "EventModifierID": 11, "DeviceID": 12, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 19 }, { "GroupID": "sample string 1", "CustomNotificationMessage": "sample string 2", "NotificationListID": 3, "ScheduleID": 4, "SecurityPanelStateCondition": 5, "NotificationTypeID": 6, "NotificationDelay": 7, "NotificationDeadLine": "sample string 8", "EventTypeID": 9, "EventItemID": 10, "EventModifierID": 11, "DeviceID": 12, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 19 } ], "SceneTriggers": [ { "SceneID": 1, "EventTypeID": 2, "EventItemID": 3, "EventModifierID": 4, "DeviceID": 5, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 12 }, { "SceneID": 1, "EventTypeID": 2, "EventItemID": 3, "EventModifierID": 4, "DeviceID": 5, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 12 } ], "VideoTriggers": [ { "ScheduleID": 1, "IsEditable": true, "SecurityPanelStateCondition": 3, "CameraID": 4, "CustomNotificationMessage": "sample string 5", "EventTypeID": 6, "EventItemID": 7, "EventModifierID": 8, "DeviceID": 9, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 16 }, { "ScheduleID": 1, "IsEditable": true, "SecurityPanelStateCondition": 3, "CameraID": 4, "CustomNotificationMessage": "sample string 5", "EventTypeID": 6, "EventItemID": 7, "EventModifierID": 8, "DeviceID": 9, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 16 } ], "TimeTriggeredActions": [ { "DeviceID": 1, "SceneID": 2, "EventItemID": 3, "TriggerTime": "sample string 4", "SelectedDayID": 5, "IsEnabled": true, "FlashEventCardType": 7 }, { "DeviceID": 1, "SceneID": 2, "EventItemID": 3, "TriggerTime": "sample string 4", "SelectedDayID": 5, "IsEnabled": true, "FlashEventCardType": 7 } ], "CloudSceneTriggers": [ { "ResponseDeviceID": 1, "EventNotificationId": 2, "ResponseModifier1": 3, "ResponseModifier2": 4, "DeviceTypeID": 5, "PartnerID": 6, "EventTypeID": 7, "EventItemID": 8, "EventModifierID": 9, "DeviceID": 10, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 17 }, { "ResponseDeviceID": 1, "EventNotificationId": 2, "ResponseModifier1": 3, "ResponseModifier2": 4, "DeviceTypeID": 5, "PartnerID": 6, "EventTypeID": 7, "EventItemID": 8, "EventModifierID": 9, "DeviceID": 10, "PartitionIDs": [ 1, 2 ], "IsEnabled": true, "IsIndividualFlow": true, "IsPushEnabled": true, "IsEmailEnabled": true, "IsSMSEnabled": true, "IsSilentEnabled": true, "FlashEventCardType": 17 } ] }
application/xml, text/xml
Sample:
<NewEventInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi.Models"> <CloudSceneTriggers xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration"> <d2p1:CloudSceneTrigger> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>10</d2p1:deviceID> <d2p1:eventItemID>8</d2p1:eventItemID> <d2p1:eventModifierID>9</d2p1:eventModifierID> <d2p1:eventTypeID>7</d2p1:eventTypeID> <d2p1:flashEventCardType>17</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:DeviceTypeID>5</d2p1:DeviceTypeID> <d2p1:EventNotificationId>2</d2p1:EventNotificationId> <d2p1:PartnerID>6</d2p1:PartnerID> <d2p1:ResponseDeviceID>1</d2p1:ResponseDeviceID> <d2p1:ResponseModifier1>3</d2p1:ResponseModifier1> <d2p1:ResponseModifier2>4</d2p1:ResponseModifier2> </d2p1:CloudSceneTrigger> <d2p1:CloudSceneTrigger> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>10</d2p1:deviceID> <d2p1:eventItemID>8</d2p1:eventItemID> <d2p1:eventModifierID>9</d2p1:eventModifierID> <d2p1:eventTypeID>7</d2p1:eventTypeID> <d2p1:flashEventCardType>17</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:DeviceTypeID>5</d2p1:DeviceTypeID> <d2p1:EventNotificationId>2</d2p1:EventNotificationId> <d2p1:PartnerID>6</d2p1:PartnerID> <d2p1:ResponseDeviceID>1</d2p1:ResponseDeviceID> <d2p1:ResponseModifier1>3</d2p1:ResponseModifier1> <d2p1:ResponseModifier2>4</d2p1:ResponseModifier2> </d2p1:CloudSceneTrigger> </CloudSceneTriggers> <EventNotification xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration"> <d2p1:EventNotification> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>12</d2p1:deviceID> <d2p1:eventItemID>10</d2p1:eventItemID> <d2p1:eventModifierID>11</d2p1:eventModifierID> <d2p1:eventTypeID>9</d2p1:eventTypeID> <d2p1:flashEventCardType>19</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:CustomNotificationMessage>sample string 2</d2p1:CustomNotificationMessage> <d2p1:GroupID>sample string 1</d2p1:GroupID> <d2p1:NotificationDeadLine>sample string 8</d2p1:NotificationDeadLine> <d2p1:NotificationDelay>7</d2p1:NotificationDelay> <d2p1:NotificationListID>3</d2p1:NotificationListID> <d2p1:NotificationTypeID>6</d2p1:NotificationTypeID> <d2p1:ScheduleID>4</d2p1:ScheduleID> <d2p1:SecurityPanelStateCondition>5</d2p1:SecurityPanelStateCondition> </d2p1:EventNotification> <d2p1:EventNotification> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>12</d2p1:deviceID> <d2p1:eventItemID>10</d2p1:eventItemID> <d2p1:eventModifierID>11</d2p1:eventModifierID> <d2p1:eventTypeID>9</d2p1:eventTypeID> <d2p1:flashEventCardType>19</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:CustomNotificationMessage>sample string 2</d2p1:CustomNotificationMessage> <d2p1:GroupID>sample string 1</d2p1:GroupID> <d2p1:NotificationDeadLine>sample string 8</d2p1:NotificationDeadLine> <d2p1:NotificationDelay>7</d2p1:NotificationDelay> <d2p1:NotificationListID>3</d2p1:NotificationListID> <d2p1:NotificationTypeID>6</d2p1:NotificationTypeID> <d2p1:ScheduleID>4</d2p1:ScheduleID> <d2p1:SecurityPanelStateCondition>5</d2p1:SecurityPanelStateCondition> </d2p1:EventNotification> </EventNotification> <SceneTriggers xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration"> <d2p1:SceneTrigger> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>5</d2p1:deviceID> <d2p1:eventItemID>3</d2p1:eventItemID> <d2p1:eventModifierID>4</d2p1:eventModifierID> <d2p1:eventTypeID>2</d2p1:eventTypeID> <d2p1:flashEventCardType>12</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:SceneID>1</d2p1:SceneID> </d2p1:SceneTrigger> <d2p1:SceneTrigger> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>5</d2p1:deviceID> <d2p1:eventItemID>3</d2p1:eventItemID> <d2p1:eventModifierID>4</d2p1:eventModifierID> <d2p1:eventTypeID>2</d2p1:eventTypeID> <d2p1:flashEventCardType>12</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:SceneID>1</d2p1:SceneID> </d2p1:SceneTrigger> </SceneTriggers> <SentToPanelEvents xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration"> <d2p1:SentToPanelEvents> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>6</d2p1:deviceID> <d2p1:eventItemID>4</d2p1:eventItemID> <d2p1:eventModifierID>5</d2p1:eventModifierID> <d2p1:eventTypeID>3</d2p1:eventTypeID> <d2p1:flashEventCardType>13</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:CustomNotificationMessage>sample string 1</d2p1:CustomNotificationMessage> <d2p1:NotificationTypeID>2</d2p1:NotificationTypeID> </d2p1:SentToPanelEvents> <d2p1:SentToPanelEvents> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>6</d2p1:deviceID> <d2p1:eventItemID>4</d2p1:eventItemID> <d2p1:eventModifierID>5</d2p1:eventModifierID> <d2p1:eventTypeID>3</d2p1:eventTypeID> <d2p1:flashEventCardType>13</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:CustomNotificationMessage>sample string 1</d2p1:CustomNotificationMessage> <d2p1:NotificationTypeID>2</d2p1:NotificationTypeID> </d2p1:SentToPanelEvents> </SentToPanelEvents> <TimeTriggeredActions xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration"> <d2p1:TimeTriggeredAction> <d2p1:DeviceID>1</d2p1:DeviceID> <d2p1:EventItemID>3</d2p1:EventItemID> <d2p1:FlashEventCardType>7</d2p1:FlashEventCardType> <d2p1:IsEnabled>true</d2p1:IsEnabled> <d2p1:SceneID>2</d2p1:SceneID> <d2p1:SelectedDayID>5</d2p1:SelectedDayID> <d2p1:TriggerTime>sample string 4</d2p1:TriggerTime> </d2p1:TimeTriggeredAction> <d2p1:TimeTriggeredAction> <d2p1:DeviceID>1</d2p1:DeviceID> <d2p1:EventItemID>3</d2p1:EventItemID> <d2p1:FlashEventCardType>7</d2p1:FlashEventCardType> <d2p1:IsEnabled>true</d2p1:IsEnabled> <d2p1:SceneID>2</d2p1:SceneID> <d2p1:SelectedDayID>5</d2p1:SelectedDayID> <d2p1:TriggerTime>sample string 4</d2p1:TriggerTime> </d2p1:TimeTriggeredAction> </TimeTriggeredActions> <VideoTriggers xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.EventNotificationConfiguration"> <d2p1:VideoTrigger> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>9</d2p1:deviceID> <d2p1:eventItemID>7</d2p1:eventItemID> <d2p1:eventModifierID>8</d2p1:eventModifierID> <d2p1:eventTypeID>6</d2p1:eventTypeID> <d2p1:flashEventCardType>16</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:CameraID>4</d2p1:CameraID> <d2p1:CustomNotificationMessage>sample string 5</d2p1:CustomNotificationMessage> <d2p1:IsEditable>true</d2p1:IsEditable> <d2p1:ScheduleID>1</d2p1:ScheduleID> <d2p1:SecurityPanelStateCondition>3</d2p1:SecurityPanelStateCondition> </d2p1:VideoTrigger> <d2p1:VideoTrigger> <d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField>true</d2p1:_x003C_IsSilentEnabled_x003E_k__BackingField> <d2p1:deviceID>9</d2p1:deviceID> <d2p1:eventItemID>7</d2p1:eventItemID> <d2p1:eventModifierID>8</d2p1:eventModifierID> <d2p1:eventTypeID>6</d2p1:eventTypeID> <d2p1:flashEventCardType>16</d2p1:flashEventCardType> <d2p1:isEmailEnabled>true</d2p1:isEmailEnabled> <d2p1:isEnabled>true</d2p1:isEnabled> <d2p1:isIndividualFlow>true</d2p1:isIndividualFlow> <d2p1:isPushEnabled>true</d2p1:isPushEnabled> <d2p1:isSMSEnabled>true</d2p1:isSMSEnabled> <d2p1:partitionIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:int>1</d4p1:int> <d4p1:int>2</d4p1:int> </d2p1:partitionIDs> <d2p1:CameraID>4</d2p1:CameraID> <d2p1:CustomNotificationMessage>sample string 5</d2p1:CustomNotificationMessage> <d2p1:IsEditable>true</d2p1:IsEditable> <d2p1:ScheduleID>1</d2p1:ScheduleID> <d2p1:SecurityPanelStateCondition>3</d2p1:SecurityPanelStateCondition> </d2p1:VideoTrigger> </VideoTriggers> </NewEventInfo>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BaseResultsName | Description | Type | Additional information |
---|---|---|---|
ResultCode | integer |
None. |
|
ResultData | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ResultCode": 1, "ResultData": "sample string 2" }
application/xml, text/xml
Sample:
<BaseResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi"> <ResultCode>1</ResultCode> <ResultData>sample string 2</ResultData> </BaseResults>