POST api/AnnouncementCentre/SaveAnnouncement

Request Information

URI Parameters

None.

Body Parameters

RequestSaveAnnouncement
NameDescriptionTypeAdditional information
id

integer

None.

title

string

None.

summary

string

None.

body

string

None.

tag

string

None.

type

string

None.

priority

string

None.

publishMode

string

None.

scheduledAt

string

None.

expiresAt

string

None.

timezone

string

None.

audienceRule

string

None.

audienceJson

string

None.

acknowledgementRequired

boolean

None.

inApp

boolean

None.

email

boolean

None.

push

boolean

None.

ctaLabel

string

None.

ctaUrl

string

None.

thumbnail

string

None.

banner

string

None.

attachmentName

string

None.

status

string

None.

cancelReason

string

None.

historyJson

string

None.

recipientIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "title": "sample string 2",
  "summary": "sample string 3",
  "body": "sample string 4",
  "tag": "sample string 5",
  "type": "sample string 6",
  "priority": "sample string 7",
  "publishMode": "sample string 8",
  "scheduledAt": "sample string 9",
  "expiresAt": "sample string 10",
  "timezone": "sample string 11",
  "audienceRule": "sample string 12",
  "audienceJson": "sample string 13",
  "acknowledgementRequired": true,
  "inApp": true,
  "email": true,
  "push": true,
  "ctaLabel": "sample string 18",
  "ctaUrl": "sample string 19",
  "thumbnail": "sample string 20",
  "banner": "sample string 21",
  "attachmentName": "sample string 22",
  "status": "sample string 23",
  "cancelReason": "sample string 24",
  "historyJson": "sample string 25",
  "recipientIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<RequestSaveAnnouncement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RRCDR_Attendance_API.Helpers.Custom">
  <acknowledgementRequired>true</acknowledgementRequired>
  <attachmentName>sample string 22</attachmentName>
  <audienceJson>sample string 13</audienceJson>
  <audienceRule>sample string 12</audienceRule>
  <banner>sample string 21</banner>
  <body>sample string 4</body>
  <cancelReason>sample string 24</cancelReason>
  <ctaLabel>sample string 18</ctaLabel>
  <ctaUrl>sample string 19</ctaUrl>
  <email>true</email>
  <expiresAt>sample string 10</expiresAt>
  <historyJson>sample string 25</historyJson>
  <id>1</id>
  <inApp>true</inApp>
  <priority>sample string 7</priority>
  <publishMode>sample string 8</publishMode>
  <push>true</push>
  <recipientIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </recipientIds>
  <scheduledAt>sample string 9</scheduledAt>
  <status>sample string 23</status>
  <summary>sample string 3</summary>
  <tag>sample string 5</tag>
  <thumbnail>sample string 20</thumbnail>
  <timezone>sample string 11</timezone>
  <title>sample string 2</title>
  <type>sample string 6</type>
</RequestSaveAnnouncement>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:
{}

application/xml, text/xml

Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />