GET api/Alert/{id}

Gets an Alert by Guid ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Guid ID of the alert

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

object

GetAlertResponse
NameDescriptionTypeAdditional 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": "12808e61-d97d-44e9-a587-b85f5f681917",
      "LastHandled": "2025-11-09T21:27:07.5726656+10:00",
      "Message": "sample string 2",
      "AlertType": 0,
      "AlertDate": "2025-11-09T21:27:07.5726656+10:00",
      "RepeatCounter": 4,
      "Category": "sample string 5",
      "SubCategory": "sample string 6",
      "IsEmail": true,
      "IsSMS": true,
      "RequiresAcknowledgement": true,
      "AcknowledgedDate": "2025-11-09T21:27:07.5726656+10:00",
      "AcknowledgementUserId": "98313669-14be-4234-ba55-5bfb31dff0cc",
      "ResendWaitTimeMinutes": 10,
      "ObjectType": 10,
      "ObjectId": "9fdf3bb8-170d-4fa4-911b-7f24459fd78f",
      "IgnoreDate": "2025-11-09T21:27:07.5726656+10:00",
      "TriggerID": 1,
      "Trigger": 0,
      "AlertRecipients": [
        {
          "AlertId": "983eeb14-789a-4597-aa8d-62f82865c840",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2025-11-09T21:27:07.5726656+10:00",
          "SMSSent": "2025-11-09T21:27:07.5726656+10:00"
        },
        {
          "AlertId": "983eeb14-789a-4597-aa8d-62f82865c840",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2025-11-09T21:27:07.5726656+10:00",
          "SMSSent": "2025-11-09T21:27:07.5726656+10:00"
        }
      ]
    },
    {
      "ID": "12808e61-d97d-44e9-a587-b85f5f681917",
      "LastHandled": "2025-11-09T21:27:07.5726656+10:00",
      "Message": "sample string 2",
      "AlertType": 0,
      "AlertDate": "2025-11-09T21:27:07.5726656+10:00",
      "RepeatCounter": 4,
      "Category": "sample string 5",
      "SubCategory": "sample string 6",
      "IsEmail": true,
      "IsSMS": true,
      "RequiresAcknowledgement": true,
      "AcknowledgedDate": "2025-11-09T21:27:07.5726656+10:00",
      "AcknowledgementUserId": "98313669-14be-4234-ba55-5bfb31dff0cc",
      "ResendWaitTimeMinutes": 10,
      "ObjectType": 10,
      "ObjectId": "9fdf3bb8-170d-4fa4-911b-7f24459fd78f",
      "IgnoreDate": "2025-11-09T21:27:07.5726656+10:00",
      "TriggerID": 1,
      "Trigger": 0,
      "AlertRecipients": [
        {
          "AlertId": "983eeb14-789a-4597-aa8d-62f82865c840",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2025-11-09T21:27:07.5726656+10:00",
          "SMSSent": "2025-11-09T21:27:07.5726656+10:00"
        },
        {
          "AlertId": "983eeb14-789a-4597-aa8d-62f82865c840",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2025-11-09T21:27:07.5726656+10:00",
          "SMSSent": "2025-11-09T21:27:07.5726656+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": "2025-11-09T21:27:07.5726656+10:00",
    "BuildDateUTC": "2025-11-09T21:27:07.5726656+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}