POST api/Alert

Creates a new instance of an Alert in the database.

Request Information

URI Parameters

None.

Body Parameters

The model to use

Name	Description	Type	Additional information
RepeatCounter	Gets or sets the alert repeat counter	integer	None.
Category	Gets or sets the alert category it belongs too	string	None.
SubCategory	Gets or sets the alert sub category it belongs too	string	None.
Message	Gets or sets the message	string	None.
SMSFriendlyMessage	Gets or sets the message that is "SMS Friendly"	string	None.
AlertType	Gets or sets the alert type	AlertType	None.
IsEmail	Gets or sets whether the alert is for email	boolean	None.
IsSMS	Gets or sets whether the alert is for sms	boolean	None.
RequiresAcknowledgement	Gets or sets the requires acknowledgement	boolean	None.
AcknowledgedDate	Gets or sets the date the alert was acknowledged	date	None.
AcknowledgementUserID	Gets or sets the id of the user the alert was acknowleged by	globally unique identifier	None.
AlertDate	Gets the alert date	date	None.
ResendWaitTimeMinutes	Gets or sets the resend wait time in minutes	integer	None.
MaxRepeat	Gets or sets the maximum repeats for an alert	integer	None.
ObjectID	Gets or sets the ID of the object this alert is for	globally unique identifier	None.
ObjectType	Gets or sets the type of object this alert is for	OwnerType	None.
IgnoreDate	Gets or sets the ignore date.	date	None.
TriggerID	Gets or sets the ID of the Band or Configured Alert that triggered this, if relevant.	integer	None.
Trigger	Gets or sets the Type of Trigger for this alert.	TriggerType	None.
GoodCounter	Gets or sets the counter for consecutive Good Readings	integer	None.
AlertRecipients	Gets or sets the list of alert recipients	Collection of AlertRecipient	None.
LastHandled	The Date and Time this alert was last handled	date	None.
ActionRequired	Whether or not an action is required for this alert	boolean	None.
ObjectInfo	Basic information for this object	ObjectInfo	None.
ID	Gets ID for this record	globally unique identifier	None.
IntID	Gets Integer ID for this record	integer	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "RepeatCounter": 1,
  "Category": "sample string 2",
  "SubCategory": "sample string 3",
  "Message": "sample string 4",
  "SMSFriendlyMessage": "sample string 5",
  "AlertType": 0,
  "IsEmail": true,
  "IsSMS": true,
  "RequiresAcknowledgement": true,
  "AcknowledgedDate": "2026-02-04T12:21:35.2752808+10:00",
  "AcknowledgementUserID": "911556e0-bfc9-4c09-b0ca-398cba1d64a4",
  "AlertDate": "2026-02-04T12:21:35.3065285",
  "ResendWaitTimeMinutes": 9,
  "MaxRepeat": 10,
  "ObjectID": "edbda750-80bf-4dcf-bfa9-ecaf1809cebb",
  "ObjectType": 10,
  "IgnoreDate": "2026-02-04T12:21:35.2752808+10:00",
  "TriggerID": 1,
  "Trigger": 0,
  "GoodCounter": 11,
  "AlertRecipients": [
    {
      "AlertID": "d89e87d7-0a22-49da-85e8-d1d821e452c9",
      "UserID": "6ad88865-53e3-4394-8300-aa5a224c1ec9",
      "EmailSent": "2026-02-04T12:21:35.2752808+10:00",
      "SMSSent": "2026-02-04T12:21:35.2752808+10:00",
      "GetsEmail": true,
      "GetsSMS": true,
      "ID": "16917e2f-a1ab-48c5-bb19-6de867865f36",
      "IntID": 0,
      "ObjectInfo": {
        "ID": "16917e2f-a1ab-48c5-bb19-6de867865f36",
        "IntID": 0,
        "Type": -1,
        "Valid": false,
        "IsEmpty": false
      }
    },
    {
      "AlertID": "d89e87d7-0a22-49da-85e8-d1d821e452c9",
      "UserID": "6ad88865-53e3-4394-8300-aa5a224c1ec9",
      "EmailSent": "2026-02-04T12:21:35.2752808+10:00",
      "SMSSent": "2026-02-04T12:21:35.2752808+10:00",
      "GetsEmail": true,
      "GetsSMS": true,
      "ID": "16917e2f-a1ab-48c5-bb19-6de867865f36",
      "IntID": 0,
      "ObjectInfo": {
        "ID": "16917e2f-a1ab-48c5-bb19-6de867865f36",
        "IntID": 0,
        "Type": -1,
        "Valid": false,
        "IsEmpty": false
      }
    }
  ],
  "LastHandled": "2026-02-04T12:21:35.2752808+10:00",
  "ActionRequired": true,
  "ObjectInfo": {
    "ID": "454e1ff3-b5ef-4453-a5a1-043bb0fce9db",
    "IntID": 0,
    "Type": 800,
    "Valid": true,
    "IsEmpty": false
  },
  "ID": "454e1ff3-b5ef-4453-a5a1-043bb0fce9db",
  "IntID": 0
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Http Status code indicating result.

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": "54d0ff37-ce21-4c00-9865-210845bf9db6",
      "LastHandled": "2026-02-04T12:21:35.3690227+10:00",
      "Message": "sample string 2",
      "AlertType": 0,
      "AlertDate": "2026-02-04T12:21:35.3690227+10:00",
      "RepeatCounter": 4,
      "Category": "sample string 5",
      "SubCategory": "sample string 6",
      "IsEmail": true,
      "IsSMS": true,
      "RequiresAcknowledgement": true,
      "AcknowledgedDate": "2026-02-04T12:21:35.3690227+10:00",
      "AcknowledgementUserId": "51ff7e87-593d-4bb6-b155-53ee74c24a50",
      "ResendWaitTimeMinutes": 10,
      "ObjectType": 10,
      "ObjectId": "7a709c3a-3321-40c1-9154-c8da33a67a11",
      "IgnoreDate": "2026-02-04T12:21:35.3690227+10:00",
      "TriggerID": 1,
      "Trigger": 0,
      "AlertRecipients": [
        {
          "AlertId": "d2fbbe6a-105d-49a1-8ff6-b0321992965a",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2026-02-04T12:21:35.3690227+10:00",
          "SMSSent": "2026-02-04T12:21:35.3690227+10:00"
        },
        {
          "AlertId": "d2fbbe6a-105d-49a1-8ff6-b0321992965a",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2026-02-04T12:21:35.3690227+10:00",
          "SMSSent": "2026-02-04T12:21:35.3690227+10:00"
        }
      ]
    },
    {
      "ID": "54d0ff37-ce21-4c00-9865-210845bf9db6",
      "LastHandled": "2026-02-04T12:21:35.3690227+10:00",
      "Message": "sample string 2",
      "AlertType": 0,
      "AlertDate": "2026-02-04T12:21:35.3690227+10:00",
      "RepeatCounter": 4,
      "Category": "sample string 5",
      "SubCategory": "sample string 6",
      "IsEmail": true,
      "IsSMS": true,
      "RequiresAcknowledgement": true,
      "AcknowledgedDate": "2026-02-04T12:21:35.3690227+10:00",
      "AcknowledgementUserId": "51ff7e87-593d-4bb6-b155-53ee74c24a50",
      "ResendWaitTimeMinutes": 10,
      "ObjectType": 10,
      "ObjectId": "7a709c3a-3321-40c1-9154-c8da33a67a11",
      "IgnoreDate": "2026-02-04T12:21:35.3690227+10:00",
      "TriggerID": 1,
      "Trigger": 0,
      "AlertRecipients": [
        {
          "AlertId": "d2fbbe6a-105d-49a1-8ff6-b0321992965a",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2026-02-04T12:21:35.3690227+10:00",
          "SMSSent": "2026-02-04T12:21:35.3690227+10:00"
        },
        {
          "AlertId": "d2fbbe6a-105d-49a1-8ff6-b0321992965a",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2026-02-04T12:21:35.3690227+10:00",
          "SMSSent": "2026-02-04T12:21:35.3690227+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-02-04T12:21:35.3690227+10:00",
    "BuildDateUTC": "2026-02-04T12:21:35.3690227+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}