POST api/v1/Reports/CampaignNotification/AddCampaignNotification

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

CampaignNotificationVM
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

EventTypeId

integer

None.

EventValue

string

None.

EventValues

Collection of EventValue

None.

EventValueId

integer

None.

PlaceHolderEventId

integer

None.

PlaceHolderEventValue

string

None.

PlaceHolderEventValueId

integer

None.

FrequencyId

integer

None.

NotificationTemplateId

integer

None.

NotificationTemplate

string

None.

NotificationTemplateDisplayName

string

None.

NotificationTypeId

integer

None.

NotificationType

string

None.

NotificationTypeDisplayName

string

None.

NotificationModeId

integer

None.

NotificationMode

string

None.

NotificationDisplayName

string

None.

CardNotificationTemplateId

integer

None.

CardNotificationTemplate

string

None.

CardNotificationTemplateDisplayName

string

None.

NotifyIn

date

None.

RecurringIn

date

None.

ShortMessage

string

None.

Message

string

None.

PlaceHolderMapping

Collection of integer

None.

LandingPageId

integer

None.

IsActive

boolean

None.

CreatedOn

date

None.

FormattedNotifyIn

string

None.

RecurringInterval

integer

None.

RecurringFrequency

string

None.

IsEventBase

boolean

None.

LandingType

string

None.

TrainingTypeMapping

Collection of integer

None.

ModifiedOn

date

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "EventTypeId": 3,
  "EventValue": "sample string 4",
  "EventValues": [
    {
      "Key": 1,
      "Value": "sample string 2"
    },
    {
      "Key": 1,
      "Value": "sample string 2"
    }
  ],
  "EventValueId": 1,
  "PlaceHolderEventId": 5,
  "PlaceHolderEventValue": "sample string 6",
  "PlaceHolderEventValueId": 1,
  "FrequencyId": 7,
  "NotificationTemplateId": 8,
  "NotificationTemplate": "sample string 9",
  "NotificationTemplateDisplayName": "sample string 10",
  "NotificationTypeId": 11,
  "NotificationType": "sample string 12",
  "NotificationTypeDisplayName": "sample string 13",
  "NotificationModeId": 14,
  "NotificationMode": "sample string 15",
  "NotificationDisplayName": "sample string 16",
  "CardNotificationTemplateId": 17,
  "CardNotificationTemplate": "sample string 18",
  "CardNotificationTemplateDisplayName": "sample string 19",
  "NotifyIn": "2024-09-08T09:35:10.3864933Z",
  "RecurringIn": "2024-09-08T09:35:10.3864933Z",
  "ShortMessage": "sample string 20",
  "Message": "sample string 21",
  "PlaceHolderMapping": [
    1,
    2
  ],
  "LandingPageId": 22,
  "IsActive": true,
  "CreatedOn": "2024-09-08T09:35:10.3864933Z",
  "FormattedNotifyIn": "sample string 25",
  "RecurringInterval": 26,
  "RecurringFrequency": "sample string 27",
  "IsEventBase": true,
  "LandingType": "sample string 29",
  "TrainingTypeMapping": [
    1,
    2
  ],
  "ModifiedOn": "2024-09-08T09:35:10.3864933Z"
}

text/html

Sample:
{"Id":1,"Name":"sample string 2","EventTypeId":3,"EventValue":"sample string 4","EventValues":[{"Key":1,"Value":"sample string 2"},{"Key":1,"Value":"sample string 2"}],"EventValueId":1,"PlaceHolderEventId":5,"PlaceHolderEventValue":"sample string 6","PlaceHolderEventValueId":1,"FrequencyId":7,"NotificationTemplateId":8,"NotificationTemplate":"sample string 9","NotificationTemplateDisplayName":"sample string 10","NotificationTypeId":11,"NotificationType":"sample string 12","NotificationTypeDisplayName":"sample string 13","NotificationModeId":14,"NotificationMode":"sample string 15","NotificationDisplayName":"sample string 16","CardNotificationTemplateId":17,"CardNotificationTemplate":"sample string 18","CardNotificationTemplateDisplayName":"sample string 19","NotifyIn":"2024-09-08T09:35:10.3864933Z","RecurringIn":"2024-09-08T09:35:10.3864933Z","ShortMessage":"sample string 20","Message":"sample string 21","PlaceHolderMapping":[1,2],"LandingPageId":22,"IsActive":true,"CreatedOn":"2024-09-08T09:35:10.3864933Z","FormattedNotifyIn":"sample string 25","RecurringInterval":26,"RecurringFrequency":"sample string 27","IsEventBase":true,"LandingType":"sample string 29","TrainingTypeMapping":[1,2],"ModifiedOn":"2024-09-08T09:35:10.3864933Z"}

text/xml

Sample:
<CampaignNotificationVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CampaignNotificationCore.Models">
  <CardNotificationTemplate>sample string 18</CardNotificationTemplate>
  <CardNotificationTemplateDisplayName>sample string 19</CardNotificationTemplateDisplayName>
  <CardNotificationTemplateId>17</CardNotificationTemplateId>
  <CreatedOn>2024-09-08T09:35:10.3864933Z</CreatedOn>
  <EventTypeId>3</EventTypeId>
  <EventValue>sample string 4</EventValue>
  <EventValueId>1</EventValueId>
  <EventValues>
    <EventValue>
      <Key>1</Key>
      <Value>sample string 2</Value>
    </EventValue>
    <EventValue>
      <Key>1</Key>
      <Value>sample string 2</Value>
    </EventValue>
  </EventValues>
  <FormattedNotifyIn>sample string 25</FormattedNotifyIn>
  <FrequencyId>7</FrequencyId>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <IsEventBase>true</IsEventBase>
  <LandingPageId>22</LandingPageId>
  <LandingType>sample string 29</LandingType>
  <Message>sample string 21</Message>
  <ModifiedOn>2024-09-08T09:35:10.3864933Z</ModifiedOn>
  <Name>sample string 2</Name>
  <NotificationDisplayName>sample string 16</NotificationDisplayName>
  <NotificationMode>sample string 15</NotificationMode>
  <NotificationModeId>14</NotificationModeId>
  <NotificationTemplate>sample string 9</NotificationTemplate>
  <NotificationTemplateDisplayName>sample string 10</NotificationTemplateDisplayName>
  <NotificationTemplateId>8</NotificationTemplateId>
  <NotificationType>sample string 12</NotificationType>
  <NotificationTypeDisplayName>sample string 13</NotificationTypeDisplayName>
  <NotificationTypeId>11</NotificationTypeId>
  <NotifyIn>2024-09-08T09:35:10.3864933Z</NotifyIn>
  <PlaceHolderEventId>5</PlaceHolderEventId>
  <PlaceHolderEventValue>sample string 6</PlaceHolderEventValue>
  <PlaceHolderEventValueId>1</PlaceHolderEventValueId>
  <PlaceHolderMapping xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PlaceHolderMapping>
  <RecurringFrequency>sample string 27</RecurringFrequency>
  <RecurringIn>2024-09-08T09:35:10.3864933Z</RecurringIn>
  <RecurringInterval>26</RecurringInterval>
  <ShortMessage>sample string 20</ShortMessage>
  <TrainingTypeMapping xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TrainingTypeMapping>
</CampaignNotificationVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, text/xml

Sample:

Sample not available.