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	The number of times this Alert has repeated	integer	None.
Category	Category for the Alert	string	None.
SubCategory	SubCategory for the Alert	string	None.
Message	Message for the Alert	string	None.
SMSFriendlyMessage	Message for the Alert in an "SMS Friendly" format	string	None.
AlertType	Type for the Alert, such as or	AlertType	None.
IsEmail	Whether or not this Alert is to utilise Email	boolean	None.
IsSMS	Whether or not this Alert is to utilise SMS	boolean	None.
RequiresAcknowledgement	Whether or not this Alert requires acknowledgement	boolean	None.
AcknowledgedDate	Date and Time for when this Alert has been acknowledged	date	None.
AcknowledgementUserID	ID of the User that has acknowledged this Alert	globally unique identifier	None.
AlertDate	Date and Time for when the Alert happened	date	None.
ResendWaitTimeMinutes	Resend Wait Time for the Alert (in minutes), to be used if it is to repeat	integer	None.
MaxRepeat	Maximum number of repeats for this Alert	integer	None.
ObjectID	ID for the Object this Alert is associated with	globally unique identifier	None.
ObjectType	Type for the Object this Alert is associated with	OwnerType	None.
IgnoreDate	Date and Time that this Alert has been ignored	date	None.
SourceID	ID of the Source of this Alert, if available	globally unique identifier	None.
SourceIntID	ID of the Source of this Alert, if available	integer	None.
SourceType	The Type for the object that is the Source of this Alert, such as a ReadingBand or Schedule	TriggerType	None.
SourceInfo	Information about the Source of this Alert	string	None.
GoodCounter	Counter for the number of consecutive "Good" readings	integer	None.
AlertRecipients	List of recipients for this Alert	Collection of AlertRecipient	None.
LastHandled	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-11-06T01:04:39.336268+10:00",
  "AcknowledgementUserID": "8ab226bb-998f-4159-8682-c28445d938fd",
  "AlertDate": "2026-11-06T01:04:39.3675157",
  "ResendWaitTimeMinutes": 9,
  "MaxRepeat": 10,
  "ObjectID": "d1aea753-9a14-4bd9-9630-83535badbf2e",
  "ObjectType": 10,
  "IgnoreDate": "2026-11-06T01:04:39.336268+10:00",
  "SourceID": "976908d6-5e13-4158-ba37-8f08293cf1cb",
  "SourceIntID": 12,
  "SourceType": 0,
  "SourceInfo": "ReadingBand 12",
  "GoodCounter": 13,
  "AlertRecipients": [
    {
      "AlertID": "5e23ac1e-67d5-4af8-985c-23b180128b9c",
      "UserID": "3d91a59c-88ae-4aa4-92ed-a7bccc323513",
      "EmailSent": "2026-11-06T01:04:39.3518922+10:00",
      "SMSSent": "2026-11-06T01:04:39.3518922+10:00",
      "GetsEmail": true,
      "GetsSMS": true,
      "ID": "b7219ef3-9b42-4c3d-b89e-35c8846cb688",
      "IntID": 0,
      "ObjectInfo": {
        "ID": "b7219ef3-9b42-4c3d-b89e-35c8846cb688",
        "IntID": 0,
        "Type": -1,
        "Valid": false,
        "IsEmpty": false
      }
    },
    {
      "AlertID": "5e23ac1e-67d5-4af8-985c-23b180128b9c",
      "UserID": "3d91a59c-88ae-4aa4-92ed-a7bccc323513",
      "EmailSent": "2026-11-06T01:04:39.3518922+10:00",
      "SMSSent": "2026-11-06T01:04:39.3518922+10:00",
      "GetsEmail": true,
      "GetsSMS": true,
      "ID": "b7219ef3-9b42-4c3d-b89e-35c8846cb688",
      "IntID": 0,
      "ObjectInfo": {
        "ID": "b7219ef3-9b42-4c3d-b89e-35c8846cb688",
        "IntID": 0,
        "Type": -1,
        "Valid": false,
        "IsEmpty": false
      }
    }
  ],
  "LastHandled": "2026-11-06T01:04:39.3518922+10:00",
  "ActionRequired": true,
  "ObjectInfo": {
    "ID": "c01fa07c-4c03-4841-bd92-4f5f36338007",
    "IntID": 0,
    "Type": 800,
    "Valid": true,
    "IsEmpty": false
  },
  "ID": "c01fa07c-4c03-4841-bd92-4f5f36338007",
  "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": "c16c6768-89bc-4799-b764-04eeb43bce35",
      "LastHandled": "2026-11-06T01:04:39.4143883+10:00",
      "Message": "sample string 2",
      "AlertType": 0,
      "AlertDate": "2026-11-06T01:04:39.4143883+10:00",
      "RepeatCounter": 4,
      "Category": "sample string 5",
      "SubCategory": "sample string 6",
      "IsEmail": true,
      "IsSMS": true,
      "RequiresAcknowledgement": true,
      "AcknowledgedDate": "2026-11-06T01:04:39.4143883+10:00",
      "AcknowledgementUserId": "33be71af-dd1d-4da7-83ca-97fe8c9f16ff",
      "ResendWaitTimeMinutes": 10,
      "ObjectType": 10,
      "ObjectId": "b05c6d8a-c49b-426f-b343-7c9fb6e32b37",
      "IgnoreDate": "2026-11-06T01:04:39.4143883+10:00",
      "SourceID": 1,
      "SourceType": 0,
      "AlertRecipients": [
        {
          "AlertId": "e8a53796-a7ac-4a3e-b8f0-b9c11cd107d9",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2026-11-06T01:04:39.4143883+10:00",
          "SMSSent": "2026-11-06T01:04:39.4143883+10:00"
        },
        {
          "AlertId": "e8a53796-a7ac-4a3e-b8f0-b9c11cd107d9",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2026-11-06T01:04:39.4143883+10:00",
          "SMSSent": "2026-11-06T01:04:39.4143883+10:00"
        }
      ]
    },
    {
      "ID": "c16c6768-89bc-4799-b764-04eeb43bce35",
      "LastHandled": "2026-11-06T01:04:39.4143883+10:00",
      "Message": "sample string 2",
      "AlertType": 0,
      "AlertDate": "2026-11-06T01:04:39.4143883+10:00",
      "RepeatCounter": 4,
      "Category": "sample string 5",
      "SubCategory": "sample string 6",
      "IsEmail": true,
      "IsSMS": true,
      "RequiresAcknowledgement": true,
      "AcknowledgedDate": "2026-11-06T01:04:39.4143883+10:00",
      "AcknowledgementUserId": "33be71af-dd1d-4da7-83ca-97fe8c9f16ff",
      "ResendWaitTimeMinutes": 10,
      "ObjectType": 10,
      "ObjectId": "b05c6d8a-c49b-426f-b343-7c9fb6e32b37",
      "IgnoreDate": "2026-11-06T01:04:39.4143883+10:00",
      "SourceID": 1,
      "SourceType": 0,
      "AlertRecipients": [
        {
          "AlertId": "e8a53796-a7ac-4a3e-b8f0-b9c11cd107d9",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2026-11-06T01:04:39.4143883+10:00",
          "SMSSent": "2026-11-06T01:04:39.4143883+10:00"
        },
        {
          "AlertId": "e8a53796-a7ac-4a3e-b8f0-b9c11cd107d9",
          "GetsEmail": true,
          "GetsSMS": true,
          "EmailSent": "2026-11-06T01:04:39.4143883+10:00",
          "SMSSent": "2026-11-06T01:04:39.4143883+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:39.4143883+10:00",
    "BuildDateUTC": "2026-11-06T01:04:39.4143883+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}