GET api/Alert/{id}

Gets an Alert by id

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the alert	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

An .

GetAlertResponse

Name	Description	Type	Additional information
Alerts	Array of Alerts		None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Alerts": [
    {
      "ID": "2197f241-baba-4d23-af4e-049f6af32038",
      "LastHandled": "2025-11-09T21:30:20.8258696+10:00",
      "Message": "sample string 2",
      "AlertType": 0,
      "AlertDate": "2025-11-09T21:30:20.8258696+10:00",
      "RepeatCounter": 4,
      "Category": "sample string 5",
      "SubCategory": "sample string 6",
      "IsEmail": true,
      "IsSMS": true,
      "RequiresAcknowledgement": true,
      "AcknowledgedDate": "2025-11-09T21:30:20.8258696+10:00",
      "AcknowledgementUserId": "d0bd722c-1f12-4b52-9489-89d78e0a393d",
      "ResendWaitTimeMinutes": 10,
      "ObjectType": 10,
      "ObjectId": "325a0a82-2861-4e1b-89e9-4ea49eef081c",
      "IgnoreDate": "2025-11-09T21:30:20.8258696+10:00",
      "TriggerID": 1,
      "Trigger": 0,
      "AlertRecipients": [
        {
          "AlertId": "dff07294-826c-405b-8793-a435983db2d9",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2025-11-09T21:30:20.8258696+10:00",
          "SMSSent": "2025-11-09T21:30:20.8258696+10:00"
        },
        {
          "AlertId": "dff07294-826c-405b-8793-a435983db2d9",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2025-11-09T21:30:20.8258696+10:00",
          "SMSSent": "2025-11-09T21:30:20.8258696+10:00"
        }
      ]
    },
    {
      "ID": "2197f241-baba-4d23-af4e-049f6af32038",
      "LastHandled": "2025-11-09T21:30:20.8258696+10:00",
      "Message": "sample string 2",
      "AlertType": 0,
      "AlertDate": "2025-11-09T21:30:20.8258696+10:00",
      "RepeatCounter": 4,
      "Category": "sample string 5",
      "SubCategory": "sample string 6",
      "IsEmail": true,
      "IsSMS": true,
      "RequiresAcknowledgement": true,
      "AcknowledgedDate": "2025-11-09T21:30:20.8258696+10:00",
      "AcknowledgementUserId": "d0bd722c-1f12-4b52-9489-89d78e0a393d",
      "ResendWaitTimeMinutes": 10,
      "ObjectType": 10,
      "ObjectId": "325a0a82-2861-4e1b-89e9-4ea49eef081c",
      "IgnoreDate": "2025-11-09T21:30:20.8258696+10:00",
      "TriggerID": 1,
      "Trigger": 0,
      "AlertRecipients": [
        {
          "AlertId": "dff07294-826c-405b-8793-a435983db2d9",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2025-11-09T21:30:20.8258696+10:00",
          "SMSSent": "2025-11-09T21:30:20.8258696+10:00"
        },
        {
          "AlertId": "dff07294-826c-405b-8793-a435983db2d9",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2025-11-09T21:30:20.8258696+10:00",
          "SMSSent": "2025-11-09T21:30:20.8258696+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:30:20.8258696+10:00",
    "BuildDateUTC": "2025-11-09T21:30:20.8258696+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml, text/xml

Sample:

<GetAlertResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
  </Messages>
  <ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
    <d2p1:BuildDateUTC>2025-11-09T21:30:20.8258696+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:30:20.8258696+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <Alerts xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
    <d2p1:APIStructs.Alert>
      <d2p1:AcknowledgedDate>2025-11-09T21:30:20.8258696+10:00</d2p1:AcknowledgedDate>
      <d2p1:AcknowledgementUserId>d0bd722c-1f12-4b52-9489-89d78e0a393d</d2p1:AcknowledgementUserId>
      <d2p1:AlertDate>2025-11-09T21:30:20.8258696+10:00</d2p1:AlertDate>
      <d2p1:AlertRecipients>
        <d2p1:APIStructs.AlertRecipient>
          <d2p1:AlertId>dff07294-826c-405b-8793-a435983db2d9</d2p1:AlertId>
          <d2p1:EmailSent>2025-11-09T21:30:20.8258696+10:00</d2p1:EmailSent>
          <d2p1:GetsEmail>true</d2p1:GetsEmail>
          <d2p1:GetsSMS>true</d2p1:GetsSMS>
          <d2p1:SMSSent>2025-11-09T21:30:20.8258696+10:00</d2p1:SMSSent>
        </d2p1:APIStructs.AlertRecipient>
        <d2p1:APIStructs.AlertRecipient>
          <d2p1:AlertId>dff07294-826c-405b-8793-a435983db2d9</d2p1:AlertId>
          <d2p1:EmailSent>2025-11-09T21:30:20.8258696+10:00</d2p1:EmailSent>
          <d2p1:GetsEmail>true</d2p1:GetsEmail>
          <d2p1:GetsSMS>true</d2p1:GetsSMS>
          <d2p1:SMSSent>2025-11-09T21:30:20.8258696+10:00</d2p1:SMSSent>
        </d2p1:APIStructs.AlertRecipient>
      </d2p1:AlertRecipients>
      <d2p1:AlertType>Message</d2p1:AlertType>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:ID>2197f241-baba-4d23-af4e-049f6af32038</d2p1:ID>
      <d2p1:IgnoreDate>2025-11-09T21:30:20.8258696+10:00</d2p1:IgnoreDate>
      <d2p1:IsEmail>true</d2p1:IsEmail>
      <d2p1:IsSMS>true</d2p1:IsSMS>
      <d2p1:LastHandled>2025-11-09T21:30:20.8258696+10:00</d2p1:LastHandled>
      <d2p1:Message>sample string 2</d2p1:Message>
      <d2p1:ObjectId>325a0a82-2861-4e1b-89e9-4ea49eef081c</d2p1:ObjectId>
      <d2p1:ObjectType>Device</d2p1:ObjectType>
      <d2p1:RepeatCounter>4</d2p1:RepeatCounter>
      <d2p1:RequiresAcknowledgement>true</d2p1:RequiresAcknowledgement>
      <d2p1:ResendWaitTimeMinutes>10</d2p1:ResendWaitTimeMinutes>
      <d2p1:SubCategory>sample string 6</d2p1:SubCategory>
      <d2p1:Trigger>ReadingBand</d2p1:Trigger>
      <d2p1:TriggerID>1</d2p1:TriggerID>
    </d2p1:APIStructs.Alert>
    <d2p1:APIStructs.Alert>
      <d2p1:AcknowledgedDate>2025-11-09T21:30:20.8258696+10:00</d2p1:AcknowledgedDate>
      <d2p1:AcknowledgementUserId>d0bd722c-1f12-4b52-9489-89d78e0a393d</d2p1:AcknowledgementUserId>
      <d2p1:AlertDate>2025-11-09T21:30:20.8258696+10:00</d2p1:AlertDate>
      <d2p1:AlertRecipients>
        <d2p1:APIStructs.AlertRecipient>
          <d2p1:AlertId>dff07294-826c-405b-8793-a435983db2d9</d2p1:AlertId>
          <d2p1:EmailSent>2025-11-09T21:30:20.8258696+10:00</d2p1:EmailSent>
          <d2p1:GetsEmail>true</d2p1:GetsEmail>
          <d2p1:GetsSMS>true</d2p1:GetsSMS>
          <d2p1:SMSSent>2025-11-09T21:30:20.8258696+10:00</d2p1:SMSSent>
        </d2p1:APIStructs.AlertRecipient>
        <d2p1:APIStructs.AlertRecipient>
          <d2p1:AlertId>dff07294-826c-405b-8793-a435983db2d9</d2p1:AlertId>
          <d2p1:EmailSent>2025-11-09T21:30:20.8258696+10:00</d2p1:EmailSent>
          <d2p1:GetsEmail>true</d2p1:GetsEmail>
          <d2p1:GetsSMS>true</d2p1:GetsSMS>
          <d2p1:SMSSent>2025-11-09T21:30:20.8258696+10:00</d2p1:SMSSent>
        </d2p1:APIStructs.AlertRecipient>
      </d2p1:AlertRecipients>
      <d2p1:AlertType>Message</d2p1:AlertType>
      <d2p1:Category>sample string 5</d2p1:Category>
      <d2p1:ID>2197f241-baba-4d23-af4e-049f6af32038</d2p1:ID>
      <d2p1:IgnoreDate>2025-11-09T21:30:20.8258696+10:00</d2p1:IgnoreDate>
      <d2p1:IsEmail>true</d2p1:IsEmail>
      <d2p1:IsSMS>true</d2p1:IsSMS>
      <d2p1:LastHandled>2025-11-09T21:30:20.8258696+10:00</d2p1:LastHandled>
      <d2p1:Message>sample string 2</d2p1:Message>
      <d2p1:ObjectId>325a0a82-2861-4e1b-89e9-4ea49eef081c</d2p1:ObjectId>
      <d2p1:ObjectType>Device</d2p1:ObjectType>
      <d2p1:RepeatCounter>4</d2p1:RepeatCounter>
      <d2p1:RequiresAcknowledgement>true</d2p1:RequiresAcknowledgement>
      <d2p1:ResendWaitTimeMinutes>10</d2p1:ResendWaitTimeMinutes>
      <d2p1:SubCategory>sample string 6</d2p1:SubCategory>
      <d2p1:Trigger>ReadingBand</d2p1:Trigger>
      <d2p1:TriggerID>1</d2p1:TriggerID>
    </d2p1:APIStructs.Alert>
  </Alerts>
</GetAlertResponse>