| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientID | integer |
Required |
|
| ClientSiteID | integer |
Required |
|
| ID |
For Update: ID of the alert to be updated. For creation, this attribute is not used. |
integer |
None. |
| Title |
Title of the alert |
string |
Required Max length: 256 |
| Content |
Content of the alert. |
string |
Required Max length: 20000 |
| StartAt |
Date and time when an alert becomes avaiable |
date |
Required |
| EndAt |
Date and time when an alert expires |
date |
Required |
| IsPublic |
True if the alert is avaiable to all subscribers |
boolean |
Required |
| Recipients |
If IsPublic = false, then this attributes contain the list of username that can see the alert. |
Collection of string |
None. |
| TypeOfAlert |
Type of alert |
AlertType |
None. |
| Gateway |
Gateway where the alert will be sent |
Gateway |
None. |
| PageUrls |
A comma separated list of Urls where the alert will be displayed. If null or *, then the alert will be displayed in all pages. |
string |
Max length: 2000 |
| OKButton |
Caption for the OK button. If null, then the default value "OK" is used. |
string |
Max length: 100 |
| CancelButton |
Caption for the Cancel button. If null, then the default value "Cancel" is used. |
string |
Max length: 100 |
| Autoclose |
If not null, then this is the number of seconds afte which the Timed alert will close. |
integer |
None. |
| CancelEvent |
Event that will be invoked if the user clicks the Cancel button for a "Must Agree" alert. |
CancelEvent |
None. |
| AlertMsg |
Message to be displayed if the user clicks the Cancel button for a "Must Agree" alert. |
string |
Max length: 2000 |
| RedirectUrl |
Url where the browser will be redirected to if the user clicks the Cancel button for a "Must Agree" alert. |
string |
Max length: 2000 |
| Department |
Only users from this Department that can view the alert. If null, then all Department can view the alert |
string |
Max length: 50 |
| Roles |
A comma separated list of Roles that can view the alert. If null, then all Roles can view the alert |
string |
Max length: 4000 |
