POST api/organizations/current/users/current/notificationevents

Adds a new NotificationEvent.



Request Information

URI Parameters

None.



Body Parameters

The NotificationEvent to add.

NotificationEventViewModel
NameDescriptionTypeAdditional 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.

Request 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",
      "EntityAttributeId": 2,
      "IsDateOfToday": true,
      "DateOfTodayDayOffset": 4,
      "ModifierId": 5,
      "RecursionPath": [
        1,
        2
      ]
    },
    {
      "CompareValue": "sample string 1",
      "EntityAttributeId": 2,
      "IsDateOfToday": true,
      "DateOfTodayDayOffset": 4,
      "ModifierId": 5,
      "RecursionPath": [
        1,
        2
      ]
    }
  ],
  "PreconditionCriteria": [
    {
      "CompareValue": "sample string 1",
      "EntityAttributeId": 2,
      "IsDateOfToday": true,
      "DateOfTodayDayOffset": 4,
      "ModifierId": 5,
      "RecursionPath": [
        1,
        2
      ]
    },
    {
      "CompareValue": "sample string 1",
      "EntityAttributeId": 2,
      "IsDateOfToday": true,
      "DateOfTodayDayOffset": 4,
      "ModifierId": 5,
      "RecursionPath": [
        1,
        2
      ]
    }
  ],
  "UpcomingEventDayOffset": 1,
  "UserSubscribers": [
    "aa8dfbf0-f185-4983-be0b-0a9c6da7c6c2",
    "62dad1db-ff26-46bc-9a94-465b3ac3bbbf"
  ]
}

application/xml, text/xml

Sample:
<NotificationEventViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <EmailSubscribers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1: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>4</DateOfTodayDayOffset>
      <EntityAttributeId>2</EntityAttributeId>
      <IsDateOfToday>true</IsDateOfToday>
      <ModifierId>5</ModifierId>
      <RecursionPath xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </RecursionPath>
    </EntityCriteriaListCriteriaViewModel>
    <EntityCriteriaListCriteriaViewModel>
      <CompareValue>sample string 1</CompareValue>
      <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
      <EntityAttributeId>2</EntityAttributeId>
      <IsDateOfToday>true</IsDateOfToday>
      <ModifierId>5</ModifierId>
      <RecursionPath xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </RecursionPath>
    </EntityCriteriaListCriteriaViewModel>
  </PostconditionCriteria>
  <PreconditionCriteria>
    <EntityCriteriaListCriteriaViewModel>
      <CompareValue>sample string 1</CompareValue>
      <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
      <EntityAttributeId>2</EntityAttributeId>
      <IsDateOfToday>true</IsDateOfToday>
      <ModifierId>5</ModifierId>
      <RecursionPath xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </RecursionPath>
    </EntityCriteriaListCriteriaViewModel>
    <EntityCriteriaListCriteriaViewModel>
      <CompareValue>sample string 1</CompareValue>
      <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
      <EntityAttributeId>2</EntityAttributeId>
      <IsDateOfToday>true</IsDateOfToday>
      <ModifierId>5</ModifierId>
      <RecursionPath xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </RecursionPath>
    </EntityCriteriaListCriteriaViewModel>
  </PreconditionCriteria>
  <UpcomingEventDayOffset>1</UpcomingEventDayOffset>
  <UserSubscribers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>aa8dfbf0-f185-4983-be0b-0a9c6da7c6c2</d2p1:guid>
    <d2p1:guid>62dad1db-ff26-46bc-9a94-465b3ac3bbbf</d2p1:guid>
  </UserSubscribers>
</NotificationEventViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.



Response Information

Resource Description

The added NotificationEvent represented as a NotificationEventViewModel.

NotificationEventViewModel

NameDescriptionTypeAdditional 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",
      "EntityAttributeId": 2,
      "IsDateOfToday": true,
      "DateOfTodayDayOffset": 4,
      "ModifierId": 5,
      "RecursionPath": [
        1,
        2
      ]
    },
    {
      "CompareValue": "sample string 1",
      "EntityAttributeId": 2,
      "IsDateOfToday": true,
      "DateOfTodayDayOffset": 4,
      "ModifierId": 5,
      "RecursionPath": [
        1,
        2
      ]
    }
  ],
  "PreconditionCriteria": [
    {
      "CompareValue": "sample string 1",
      "EntityAttributeId": 2,
      "IsDateOfToday": true,
      "DateOfTodayDayOffset": 4,
      "ModifierId": 5,
      "RecursionPath": [
        1,
        2
      ]
    },
    {
      "CompareValue": "sample string 1",
      "EntityAttributeId": 2,
      "IsDateOfToday": true,
      "DateOfTodayDayOffset": 4,
      "ModifierId": 5,
      "RecursionPath": [
        1,
        2
      ]
    }
  ],
  "UpcomingEventDayOffset": 1,
  "UserSubscribers": [
    "60022985-acb5-4995-a0af-c1c4d0c2e7e8",
    "4344a9ac-243b-4f1f-bd87-28bcd7b538b6"
  ]
}

application/xml, text/xml

Sample:
<NotificationEventViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <EmailSubscribers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1: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>4</DateOfTodayDayOffset>
      <EntityAttributeId>2</EntityAttributeId>
      <IsDateOfToday>true</IsDateOfToday>
      <ModifierId>5</ModifierId>
      <RecursionPath xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </RecursionPath>
    </EntityCriteriaListCriteriaViewModel>
    <EntityCriteriaListCriteriaViewModel>
      <CompareValue>sample string 1</CompareValue>
      <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
      <EntityAttributeId>2</EntityAttributeId>
      <IsDateOfToday>true</IsDateOfToday>
      <ModifierId>5</ModifierId>
      <RecursionPath xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </RecursionPath>
    </EntityCriteriaListCriteriaViewModel>
  </PostconditionCriteria>
  <PreconditionCriteria>
    <EntityCriteriaListCriteriaViewModel>
      <CompareValue>sample string 1</CompareValue>
      <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
      <EntityAttributeId>2</EntityAttributeId>
      <IsDateOfToday>true</IsDateOfToday>
      <ModifierId>5</ModifierId>
      <RecursionPath xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </RecursionPath>
    </EntityCriteriaListCriteriaViewModel>
    <EntityCriteriaListCriteriaViewModel>
      <CompareValue>sample string 1</CompareValue>
      <DateOfTodayDayOffset>4</DateOfTodayDayOffset>
      <EntityAttributeId>2</EntityAttributeId>
      <IsDateOfToday>true</IsDateOfToday>
      <ModifierId>5</ModifierId>
      <RecursionPath xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>1</d4p1:long>
        <d4p1:long>2</d4p1:long>
      </RecursionPath>
    </EntityCriteriaListCriteriaViewModel>
  </PreconditionCriteria>
  <UpcomingEventDayOffset>1</UpcomingEventDayOffset>
  <UserSubscribers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>60022985-acb5-4995-a0af-c1c4d0c2e7e8</d2p1:guid>
    <d2p1:guid>4344a9ac-243b-4f1f-bd87-28bcd7b538b6</d2p1:guid>
  </UserSubscribers>
</NotificationEventViewModel>