GET api/Alert
Gets all Alerts you have access to
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of Alerts.
GetAlertResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Alerts |
Array of Alerts |
Collection of AlertStruct |
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:
{
"Alerts": [
{
"ID": "5692419d-da20-4706-9301-fdf5d7c27b56",
"LastHandled": "2026-11-06T01:04:38.8673509+10:00",
"Message": "sample string 2",
"AlertType": 0,
"AlertDate": "2026-11-06T01:04:38.8673509+10:00",
"RepeatCounter": 4,
"Category": "sample string 5",
"SubCategory": "sample string 6",
"IsEmail": true,
"IsSMS": true,
"RequiresAcknowledgement": true,
"AcknowledgedDate": "2026-11-06T01:04:38.8673509+10:00",
"AcknowledgementUserId": "5105c295-3683-4887-a9a0-7c4a0e4abe7a",
"ResendWaitTimeMinutes": 10,
"ObjectType": 10,
"ObjectId": "9fe13bdd-03cf-4f74-9fa7-d6cd08f519e8",
"IgnoreDate": "2026-11-06T01:04:38.8673509+10:00",
"SourceID": 1,
"SourceType": 0,
"AlertRecipients": [
{
"AlertId": "8d9a425b-4805-4016-9a37-aecb1997073a",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-11-06T01:04:38.8673509+10:00",
"SMSSent": "2026-11-06T01:04:38.8673509+10:00"
},
{
"AlertId": "8d9a425b-4805-4016-9a37-aecb1997073a",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-11-06T01:04:38.8673509+10:00",
"SMSSent": "2026-11-06T01:04:38.8673509+10:00"
}
]
},
{
"ID": "5692419d-da20-4706-9301-fdf5d7c27b56",
"LastHandled": "2026-11-06T01:04:38.8673509+10:00",
"Message": "sample string 2",
"AlertType": 0,
"AlertDate": "2026-11-06T01:04:38.8673509+10:00",
"RepeatCounter": 4,
"Category": "sample string 5",
"SubCategory": "sample string 6",
"IsEmail": true,
"IsSMS": true,
"RequiresAcknowledgement": true,
"AcknowledgedDate": "2026-11-06T01:04:38.8673509+10:00",
"AcknowledgementUserId": "5105c295-3683-4887-a9a0-7c4a0e4abe7a",
"ResendWaitTimeMinutes": 10,
"ObjectType": 10,
"ObjectId": "9fe13bdd-03cf-4f74-9fa7-d6cd08f519e8",
"IgnoreDate": "2026-11-06T01:04:38.8673509+10:00",
"SourceID": 1,
"SourceType": 0,
"AlertRecipients": [
{
"AlertId": "8d9a425b-4805-4016-9a37-aecb1997073a",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-11-06T01:04:38.8673509+10:00",
"SMSSent": "2026-11-06T01:04:38.8673509+10:00"
},
{
"AlertId": "8d9a425b-4805-4016-9a37-aecb1997073a",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-11-06T01:04:38.8673509+10:00",
"SMSSent": "2026-11-06T01:04:38.8673509+10:00"
}
]
}
],
"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": "2026-11-06T01:04:38.8673509+10:00",
"BuildDateUTC": "2026-11-06T01:04:38.8673509+10:00"
},
"VersionInformation": {
"Major": 1,
"Minor": 8,
"Hotfix": 0,
"Beta": true,
"Version": "1.8.0.BETA"
}
}