POST api/Alert/Acknowledge

Acknowledges any number of Alerts based on the input details provided within

Request Information

URI Parameters

None.

Body Parameters

Filter information

AlertFilter
NameDescriptionTypeAdditional information
Start

Start date for alerts to filter, if provided

date

None.

End

End date for alerts to filter, if provided

date

None.

AlertType

AlertType to filter, if provided

AlertType

None.

Category

Category for alerts to filter, if provided

string

None.

SubCategory

SubCategory for alerts to filter, if provided

string

None.

ClientID

Client Integer ID for alerts to filter, if provided

integer

None.

LocationID

Location Integer ID for alerts to filter, if provided

integer

None.

NetworkID

Network Integer ID for alerts to filter, if provided

integer

None.

MessageContains

Custom string to check that the Alert's message contains

string

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "Start": "2025-11-09T21:42:38.7273713+10:00",
  "End": "2025-11-09T21:42:38.7273713+10:00",
  "AlertType": 0,
  "Category": "sample string 1",
  "SubCategory": "sample string 2",
  "ClientID": 1,
  "LocationID": 1,
  "NetworkID": 1,
  "MessageContains": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Count of alerts acknowledged

GetCountResponse
NameDescriptionTypeAdditional information
Count

The count

integer

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:
{
  "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:42:38.7429956+10:00",
    "BuildDateUTC": "2025-11-09T21:42:38.7429956+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "Count": 1
}