PUT api/Notifications

CreateOnDemandNotification - Creates OnDemand Notifications

Request Information

URI Parameters

None.

Body Parameters

Notification Requests

Collection of NotificationRequest

Name	Type	Additional information
NotificationID	string	None.
ReferenceID	string	None.
Subject	string	None.
Message	string	None.
CreatedByUserName	string	None.
Date	date	None.
ToContacts	Collection of NotificationContactAssignmentRequest	None.
ToDistributionList	Collection of DistributionListRequest	None.
ToEmail	Collection of string	None.
ToSms	Collection of string	None.
TypeOfNotification	INotificationType	None.
FromContact	string	None.
TypeOfTriggerEventKey	string	None.
Documents	Collection of IDocument	None.
Replies	Collection of INotificationReplyEntry	None.
NotificationCategoryKey	string	None.
FirstRef	string	None.
SecondRef	string	None.
EMOS	boolean	None.
Email	boolean	None.
SMS	boolean	None.
Priority	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "NotificationID": "sample string 1",
    "ReferenceID": "sample string 2",
    "Subject": "sample string 3",
    "Message": "sample string 4",
    "CreatedByUserName": "sample string 5",
    "Date": "2024-11-28T12:42:04.1084174+00:00",
    "ToContacts": [
      {
        "Id": "sample string 1",
        "Noticed": true,
        "Read": true,
        "Expired": true,
        "Name": "sample string 5",
        "EmailId": "sample string 6",
        "PhoneNumber": "sample string 7"
      },
      {
        "Id": "sample string 1",
        "Noticed": true,
        "Read": true,
        "Expired": true,
        "Name": "sample string 5",
        "EmailId": "sample string 6",
        "PhoneNumber": "sample string 7"
      }
    ],
    "ToDistributionList": [
      {
        "DistributionListId": "sample string 1",
        "EocId": "sample string 2",
        "EocName": "sample string 3",
        "Name": "sample string 4",
        "Description": "sample string 5",
        "Contacts": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Email": "sample string 3",
            "PhoneNumber": "sample string 4",
            "Noticed": true,
            "Read": true,
            "Expired": true
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Email": "sample string 3",
            "PhoneNumber": "sample string 4",
            "Noticed": true,
            "Read": true,
            "Expired": true
          }
        ],
        "Created": "2024-11-28T12:42:04.1084174+00:00"
      },
      {
        "DistributionListId": "sample string 1",
        "EocId": "sample string 2",
        "EocName": "sample string 3",
        "Name": "sample string 4",
        "Description": "sample string 5",
        "Contacts": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Email": "sample string 3",
            "PhoneNumber": "sample string 4",
            "Noticed": true,
            "Read": true,
            "Expired": true
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Email": "sample string 3",
            "PhoneNumber": "sample string 4",
            "Noticed": true,
            "Read": true,
            "Expired": true
          }
        ],
        "Created": "2024-11-28T12:42:04.1084174+00:00"
      }
    ],
    "ToEmail": [
      "sample string 1",
      "sample string 2"
    ],
    "ToSms": [
      "sample string 1",
      "sample string 2"
    ],
    "TypeOfNotification": null,
    "FromContact": "sample string 7",
    "TypeOfTriggerEventKey": "sample string 8",
    "Documents": null,
    "Replies": null,
    "NotificationCategoryKey": "sample string 9",
    "FirstRef": "sample string 10",
    "SecondRef": "sample string 11",
    "EMOS": true,
    "Email": true,
    "SMS": true,
    "Priority": "sample string 15"
  },
  {
    "NotificationID": "sample string 1",
    "ReferenceID": "sample string 2",
    "Subject": "sample string 3",
    "Message": "sample string 4",
    "CreatedByUserName": "sample string 5",
    "Date": "2024-11-28T12:42:04.1084174+00:00",
    "ToContacts": [
      {
        "Id": "sample string 1",
        "Noticed": true,
        "Read": true,
        "Expired": true,
        "Name": "sample string 5",
        "EmailId": "sample string 6",
        "PhoneNumber": "sample string 7"
      },
      {
        "Id": "sample string 1",
        "Noticed": true,
        "Read": true,
        "Expired": true,
        "Name": "sample string 5",
        "EmailId": "sample string 6",
        "PhoneNumber": "sample string 7"
      }
    ],
    "ToDistributionList": [
      {
        "DistributionListId": "sample string 1",
        "EocId": "sample string 2",
        "EocName": "sample string 3",
        "Name": "sample string 4",
        "Description": "sample string 5",
        "Contacts": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Email": "sample string 3",
            "PhoneNumber": "sample string 4",
            "Noticed": true,
            "Read": true,
            "Expired": true
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Email": "sample string 3",
            "PhoneNumber": "sample string 4",
            "Noticed": true,
            "Read": true,
            "Expired": true
          }
        ],
        "Created": "2024-11-28T12:42:04.1084174+00:00"
      },
      {
        "DistributionListId": "sample string 1",
        "EocId": "sample string 2",
        "EocName": "sample string 3",
        "Name": "sample string 4",
        "Description": "sample string 5",
        "Contacts": [
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Email": "sample string 3",
            "PhoneNumber": "sample string 4",
            "Noticed": true,
            "Read": true,
            "Expired": true
          },
          {
            "Id": "sample string 1",
            "Name": "sample string 2",
            "Email": "sample string 3",
            "PhoneNumber": "sample string 4",
            "Noticed": true,
            "Read": true,
            "Expired": true
          }
        ],
        "Created": "2024-11-28T12:42:04.1084174+00:00"
      }
    ],
    "ToEmail": [
      "sample string 1",
      "sample string 2"
    ],
    "ToSms": [
      "sample string 1",
      "sample string 2"
    ],
    "TypeOfNotification": null,
    "FromContact": "sample string 7",
    "TypeOfTriggerEventKey": "sample string 8",
    "Documents": null,
    "Replies": null,
    "NotificationCategoryKey": "sample string 9",
    "FirstRef": "sample string 10",
    "SecondRef": "sample string 11",
    "EMOS": true,
    "Email": true,
    "SMS": true,
    "Priority": "sample string 15"
  }
]

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.