GET api/organizations/current/users/current/notification-events?entityDefinitionId={entityDefinitionId}&entityCategoryId={entityCategoryId}&entityAttributeId={entityAttributeId}&entityInstanceId={entityInstanceId}¬ificationEventScope={notificationEventScope}¬ificationEventType={notificationEventType}¬ificationEventSubject={notificationEventSubject}¬ificationEventActionType={notificationEventActionType}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
entityDefinitionId | integer |
Required |
|
entityCategoryId | integer |
Required |
|
entityAttributeId | integer |
Required |
|
entityInstanceId | integer |
Required |
|
notificationEventScope | NotificationEventScope |
Required |
|
notificationEventType | NotificationEventType |
Required |
|
notificationEventSubject | NotificationEventSubject |
Required |
|
notificationEventActionType | NotificationEventActionType |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of NotificationEventViewModelName | Description | Type | Additional information |
---|---|---|---|
EmailSubscribers | Collection of string |
None. |
|
EntityAttributeId | integer |
None. |
|
EntityCategoryId | integer |
None. |
|
EntityDefinitionId | integer |
None. |
|
EntityInstanceId | integer |
None. |
|
Id | integer |
None. |
|
NotificationEventActionTypeId | integer |
None. |
|
NotificationEventScopeId | integer |
None. |
|
NotificationEventSubjectId | integer |
None. |
|
NotificationEventTypeId | integer |
None. |
|
PostconditionCriteria | Collection of EntityCriteriaListCriteriaViewModel |
None. |
|
PreconditionCriteria | Collection of EntityCriteriaListCriteriaViewModel |
None. |
|
UpcomingEventDayOffset | integer |
None. |
|
UserSubscribers | Collection of globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[ { "EmailSubscribers": [ "sample string 1", "sample string 2" ], "EntityAttributeId": 1, "EntityCategoryId": 1, "EntityDefinitionId": 1, "EntityInstanceId": 1, "Id": 1, "NotificationEventActionTypeId": 2, "NotificationEventScopeId": 3, "NotificationEventSubjectId": 4, "NotificationEventTypeId": 5, "PostconditionCriteria": [ { "CompareValue": "sample string 1", "DateOfTodayDayOffset": 2, "EntityAttributeId": 3, "IsDateOfToday": true, "IsCurrentUser": true, "ModifierId": 6, "RecursionPath": [ 1, 2 ] }, { "CompareValue": "sample string 1", "DateOfTodayDayOffset": 2, "EntityAttributeId": 3, "IsDateOfToday": true, "IsCurrentUser": true, "ModifierId": 6, "RecursionPath": [ 1, 2 ] } ], "PreconditionCriteria": [ { "CompareValue": "sample string 1", "DateOfTodayDayOffset": 2, "EntityAttributeId": 3, "IsDateOfToday": true, "IsCurrentUser": true, "ModifierId": 6, "RecursionPath": [ 1, 2 ] }, { "CompareValue": "sample string 1", "DateOfTodayDayOffset": 2, "EntityAttributeId": 3, "IsDateOfToday": true, "IsCurrentUser": true, "ModifierId": 6, "RecursionPath": [ 1, 2 ] } ], "UpcomingEventDayOffset": 1, "UserSubscribers": [ "2cfa5a84-64a2-41a9-9148-43da5a64662a", "35c47b6c-2833-4533-a21b-82414dd14384" ] }, { "EmailSubscribers": [ "sample string 1", "sample string 2" ], "EntityAttributeId": 1, "EntityCategoryId": 1, "EntityDefinitionId": 1, "EntityInstanceId": 1, "Id": 1, "NotificationEventActionTypeId": 2, "NotificationEventScopeId": 3, "NotificationEventSubjectId": 4, "NotificationEventTypeId": 5, "PostconditionCriteria": [ { "CompareValue": "sample string 1", "DateOfTodayDayOffset": 2, "EntityAttributeId": 3, "IsDateOfToday": true, "IsCurrentUser": true, "ModifierId": 6, "RecursionPath": [ 1, 2 ] }, { "CompareValue": "sample string 1", "DateOfTodayDayOffset": 2, "EntityAttributeId": 3, "IsDateOfToday": true, "IsCurrentUser": true, "ModifierId": 6, "RecursionPath": [ 1, 2 ] } ], "PreconditionCriteria": [ { "CompareValue": "sample string 1", "DateOfTodayDayOffset": 2, "EntityAttributeId": 3, "IsDateOfToday": true, "IsCurrentUser": true, "ModifierId": 6, "RecursionPath": [ 1, 2 ] }, { "CompareValue": "sample string 1", "DateOfTodayDayOffset": 2, "EntityAttributeId": 3, "IsDateOfToday": true, "IsCurrentUser": true, "ModifierId": 6, "RecursionPath": [ 1, 2 ] } ], "UpcomingEventDayOffset": 1, "UserSubscribers": [ "2cfa5a84-64a2-41a9-9148-43da5a64662a", "35c47b6c-2833-4533-a21b-82414dd14384" ] } ]
application/xml, text/xml
Sample:
<ArrayOfNotificationEventViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels"> <NotificationEventViewModel> <EmailSubscribers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </EmailSubscribers> <EntityAttributeId>1</EntityAttributeId> <EntityCategoryId>1</EntityCategoryId> <EntityDefinitionId>1</EntityDefinitionId> <EntityInstanceId>1</EntityInstanceId> <Id>1</Id> <NotificationEventActionTypeId>2</NotificationEventActionTypeId> <NotificationEventScopeId>3</NotificationEventScopeId> <NotificationEventSubjectId>4</NotificationEventSubjectId> <NotificationEventTypeId>5</NotificationEventTypeId> <PostconditionCriteria> <EntityCriteriaListCriteriaViewModel> <CompareValue>sample string 1</CompareValue> <DateOfTodayDayOffset>2</DateOfTodayDayOffset> <EntityAttributeId>3</EntityAttributeId> <IsCurrentUser>true</IsCurrentUser> <IsDateOfToday>true</IsDateOfToday> <ModifierId>6</ModifierId> <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:long>1</d5p1:long> <d5p1:long>2</d5p1:long> </RecursionPath> </EntityCriteriaListCriteriaViewModel> <EntityCriteriaListCriteriaViewModel> <CompareValue>sample string 1</CompareValue> <DateOfTodayDayOffset>2</DateOfTodayDayOffset> <EntityAttributeId>3</EntityAttributeId> <IsCurrentUser>true</IsCurrentUser> <IsDateOfToday>true</IsDateOfToday> <ModifierId>6</ModifierId> <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:long>1</d5p1:long> <d5p1:long>2</d5p1:long> </RecursionPath> </EntityCriteriaListCriteriaViewModel> </PostconditionCriteria> <PreconditionCriteria> <EntityCriteriaListCriteriaViewModel> <CompareValue>sample string 1</CompareValue> <DateOfTodayDayOffset>2</DateOfTodayDayOffset> <EntityAttributeId>3</EntityAttributeId> <IsCurrentUser>true</IsCurrentUser> <IsDateOfToday>true</IsDateOfToday> <ModifierId>6</ModifierId> <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:long>1</d5p1:long> <d5p1:long>2</d5p1:long> </RecursionPath> </EntityCriteriaListCriteriaViewModel> <EntityCriteriaListCriteriaViewModel> <CompareValue>sample string 1</CompareValue> <DateOfTodayDayOffset>2</DateOfTodayDayOffset> <EntityAttributeId>3</EntityAttributeId> <IsCurrentUser>true</IsCurrentUser> <IsDateOfToday>true</IsDateOfToday> <ModifierId>6</ModifierId> <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:long>1</d5p1:long> <d5p1:long>2</d5p1:long> </RecursionPath> </EntityCriteriaListCriteriaViewModel> </PreconditionCriteria> <UpcomingEventDayOffset>1</UpcomingEventDayOffset> <UserSubscribers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>2cfa5a84-64a2-41a9-9148-43da5a64662a</d3p1:guid> <d3p1:guid>35c47b6c-2833-4533-a21b-82414dd14384</d3p1:guid> </UserSubscribers> </NotificationEventViewModel> <NotificationEventViewModel> <EmailSubscribers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </EmailSubscribers> <EntityAttributeId>1</EntityAttributeId> <EntityCategoryId>1</EntityCategoryId> <EntityDefinitionId>1</EntityDefinitionId> <EntityInstanceId>1</EntityInstanceId> <Id>1</Id> <NotificationEventActionTypeId>2</NotificationEventActionTypeId> <NotificationEventScopeId>3</NotificationEventScopeId> <NotificationEventSubjectId>4</NotificationEventSubjectId> <NotificationEventTypeId>5</NotificationEventTypeId> <PostconditionCriteria> <EntityCriteriaListCriteriaViewModel> <CompareValue>sample string 1</CompareValue> <DateOfTodayDayOffset>2</DateOfTodayDayOffset> <EntityAttributeId>3</EntityAttributeId> <IsCurrentUser>true</IsCurrentUser> <IsDateOfToday>true</IsDateOfToday> <ModifierId>6</ModifierId> <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:long>1</d5p1:long> <d5p1:long>2</d5p1:long> </RecursionPath> </EntityCriteriaListCriteriaViewModel> <EntityCriteriaListCriteriaViewModel> <CompareValue>sample string 1</CompareValue> <DateOfTodayDayOffset>2</DateOfTodayDayOffset> <EntityAttributeId>3</EntityAttributeId> <IsCurrentUser>true</IsCurrentUser> <IsDateOfToday>true</IsDateOfToday> <ModifierId>6</ModifierId> <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:long>1</d5p1:long> <d5p1:long>2</d5p1:long> </RecursionPath> </EntityCriteriaListCriteriaViewModel> </PostconditionCriteria> <PreconditionCriteria> <EntityCriteriaListCriteriaViewModel> <CompareValue>sample string 1</CompareValue> <DateOfTodayDayOffset>2</DateOfTodayDayOffset> <EntityAttributeId>3</EntityAttributeId> <IsCurrentUser>true</IsCurrentUser> <IsDateOfToday>true</IsDateOfToday> <ModifierId>6</ModifierId> <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:long>1</d5p1:long> <d5p1:long>2</d5p1:long> </RecursionPath> </EntityCriteriaListCriteriaViewModel> <EntityCriteriaListCriteriaViewModel> <CompareValue>sample string 1</CompareValue> <DateOfTodayDayOffset>2</DateOfTodayDayOffset> <EntityAttributeId>3</EntityAttributeId> <IsCurrentUser>true</IsCurrentUser> <IsDateOfToday>true</IsDateOfToday> <ModifierId>6</ModifierId> <RecursionPath xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:long>1</d5p1:long> <d5p1:long>2</d5p1:long> </RecursionPath> </EntityCriteriaListCriteriaViewModel> </PreconditionCriteria> <UpcomingEventDayOffset>1</UpcomingEventDayOffset> <UserSubscribers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>2cfa5a84-64a2-41a9-9148-43da5a64662a</d3p1:guid> <d3p1:guid>35c47b6c-2833-4533-a21b-82414dd14384</d3p1:guid> </UserSubscribers> </NotificationEventViewModel> </ArrayOfNotificationEventViewModel>