GET api/ConfiguredAlert
Gets all Alerts you have access to
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of Alerts.
GetConfiguredAlertResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ConfiguredAlerts |
Array of Configured Alerts |
Collection of ConfiguredAlert |
None. |
| Messages |
Array of messages |
Collection of Message |
None. |
| ServerInformation |
Relevant information regarding the Server |
ServerInformation |
None. |
| VersionInformation |
Relevant information regarding the API's version |
VersionInformation |
None. |
Response Formats
application/json, text/json, text/html
Sample:
{
"ConfiguredAlerts": [
{
"ID": 1,
"Enabled": true,
"Name": "sample string 3",
"Description": "sample string 4",
"AlertType": 0,
"MaxRepeats": 5,
"WaitTime": 6,
"OwnerID": 7,
"OwnerType": 10,
"Type": 0,
"CheckInControlled": true
},
{
"ID": 1,
"Enabled": true,
"Name": "sample string 3",
"Description": "sample string 4",
"AlertType": 0,
"MaxRepeats": 5,
"WaitTime": 6,
"OwnerID": 7,
"OwnerType": 10,
"Type": 0,
"CheckInControlled": true
}
],
"Messages": [
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
},
{
"Severity": 0,
"MessageCode": 1,
"CodeDesc": 2,
"MessageText": "sample string 3",
"RecordNumber": 4
}
],
"ServerInformation": {
"CurrentTimeUTC": "2025-11-09T21:25:12.4435566+10:00",
"BuildDateUTC": "2025-11-09T21:25:12.4435566+10:00"
},
"VersionInformation": {
"Major": 1,
"Minor": 8,
"Hotfix": 0,
"Beta": true,
"Version": "1.8.0.BETA"
}
}