POST api/command/notification

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
NotificationID	integer	None.
Name	string	None.
Description	string	None.
StartDate	date	None.
EndDate	date	None.
Enabled	boolean	None.
SendNow	boolean	None.
FrequencyPlan	FrequencyPlan	None.
Groups	GroupSpecs	None.
MessageSpec	MessageSpec	None.
ImageBlob	string	None.

Request Formats

application/json, text/json

Sample:

{
  "NotificationID": 1,
  "Name": "sample string 1",
  "Description": "sample string 2",
  "StartDate": "2025-06-23T19:23:45.1184666+00:00",
  "EndDate": "2025-06-23T19:23:45.1184666+00:00",
  "Enabled": true,
  "SendNow": true,
  "FrequencyPlan": {
    "Frequency": 0,
    "Hour": 1,
    "DaysOfTheWeek": [
      1,
      2
    ]
  },
  "Groups": {
    "GroupIDs": [
      1,
      2
    ],
    "ClientIDs": [
      1,
      2
    ]
  },
  "MessageSpec": {
    "MessageType": 0,
    "Message": "sample string 1",
    "Title": "sample string 2"
  },
  "ImageBlob": "sample string 7"
}

application/xml, text/xml

Sample:

<NotificationBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Wissp">
  <Description>sample string 2</Description>
  <Enabled>true</Enabled>
  <EndDate>2025-06-23T19:23:45.1184666+00:00</EndDate>
  <FrequencyPlan>
    <DaysOfTheWeek xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DaysOfTheWeek>
    <Frequency>Daily</Frequency>
    <Hour>1</Hour>
  </FrequencyPlan>
  <Groups>
    <ClientIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ClientIDs>
    <GroupIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </GroupIDs>
  </Groups>
  <ImageBlob>sample string 7</ImageBlob>
  <MessageSpec>
    <Message>sample string 1</Message>
    <MessageType>SMS</MessageType>
    <Title>sample string 2</Title>
  </MessageSpec>
  <Name>sample string 1</Name>
  <NotificationID>1</NotificationID>
  <SendNow>true</SendNow>
  <StartDate>2025-06-23T19:23:45.1184666+00:00</StartDate>
</NotificationBase>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NotificationBase'.

Response Information

Resource Description

Notification

Name	Type	Additional information
Error	string	None.
NotificationID	integer	None.
Name	string	None.
Description	string	None.
StartDate	date	None.
EndDate	date	None.
Enabled	boolean	None.
SendNow	boolean	None.
FrequencyPlan	FrequencyPlan	None.
Groups	GroupSpecs	None.
MessageSpec	MessageSpec	None.
ImageBlob	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": "sample string 1",
  "NotificationID": 1,
  "Name": "sample string 2",
  "Description": "sample string 3",
  "StartDate": "2025-06-23T19:23:45.1966105+00:00",
  "EndDate": "2025-06-23T19:23:45.1966105+00:00",
  "Enabled": true,
  "SendNow": true,
  "FrequencyPlan": {
    "Frequency": 0,
    "Hour": 1,
    "DaysOfTheWeek": [
      1,
      2
    ]
  },
  "Groups": {
    "GroupIDs": [
      1,
      2
    ],
    "ClientIDs": [
      1,
      2
    ]
  },
  "MessageSpec": {
    "MessageType": 0,
    "Message": "sample string 1",
    "Title": "sample string 2"
  },
  "ImageBlob": "sample string 8"
}

application/xml, text/xml

Sample:

<Notification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Wissp">
  <Description>sample string 3</Description>
  <Enabled>true</Enabled>
  <EndDate>2025-06-23T19:23:45.1966105+00:00</EndDate>
  <FrequencyPlan>
    <DaysOfTheWeek xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DaysOfTheWeek>
    <Frequency>Daily</Frequency>
    <Hour>1</Hour>
  </FrequencyPlan>
  <Groups>
    <ClientIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ClientIDs>
    <GroupIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </GroupIDs>
  </Groups>
  <ImageBlob>sample string 8</ImageBlob>
  <MessageSpec>
    <Message>sample string 1</Message>
    <MessageType>SMS</MessageType>
    <Title>sample string 2</Title>
  </MessageSpec>
  <Name>sample string 2</Name>
  <NotificationID>1</NotificationID>
  <SendNow>true</SendNow>
  <StartDate>2025-06-23T19:23:45.1966105+00:00</StartDate>
  <Error>sample string 1</Error>
</Notification>