POST api/Alert
Creates a new instance of an Alert in the database.
Request Information
URI Parameters
None.
Body Parameters
The model to use
Alert| 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. |
| CreateDt |
Gets Create date/time |
date |
None. |
| UpdateDt |
Gets last update date/time |
date |
None. |
Request Formats
application/json, text/json, text/html
{
"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-06-30T19:28:29.3042258+10:00",
"AcknowledgementUserID": "a17ad204-2383-49e6-8b7b-0cd1c32902b6",
"AlertDate": "2026-06-30T19:28:29.3199419",
"ResendWaitTimeMinutes": 9,
"MaxRepeat": 10,
"ObjectID": "75ab42dc-8ff9-47fc-82cc-2fc53b2ae982",
"ObjectType": 10,
"IgnoreDate": "2026-06-30T19:28:29.3042258+10:00",
"SourceID": "563b9a2c-bff7-4b68-91dc-f0a89e030981",
"SourceIntID": 12,
"SourceType": 0,
"SourceInfo": "ReadingBand 12",
"GoodCounter": 13,
"AlertRecipients": [
{
"AlertID": "facf061b-4def-49be-ab2f-002e2afbc7b5",
"UserID": "75633636-9a81-4fae-af4e-9750659238e5",
"EmailSent": "2026-06-30T19:28:29.3042258+10:00",
"SMSSent": "2026-06-30T19:28:29.3042258+10:00",
"GetsEmail": true,
"GetsSMS": true,
"ID": "293263b9-c312-4bc6-bc27-545902ba1474",
"IntID": 0,
"CreateDt": "2026-06-30T19:28:29.3356289",
"UpdateDt": "2026-06-30T19:28:29.3356289",
"ObjectInfo": {
"ID": "293263b9-c312-4bc6-bc27-545902ba1474",
"IntID": 0,
"Type": -1,
"Valid": false,
"IsEmpty": false
}
},
{
"AlertID": "facf061b-4def-49be-ab2f-002e2afbc7b5",
"UserID": "75633636-9a81-4fae-af4e-9750659238e5",
"EmailSent": "2026-06-30T19:28:29.3042258+10:00",
"SMSSent": "2026-06-30T19:28:29.3042258+10:00",
"GetsEmail": true,
"GetsSMS": true,
"ID": "293263b9-c312-4bc6-bc27-545902ba1474",
"IntID": 0,
"CreateDt": "2026-06-30T19:28:29.3356289",
"UpdateDt": "2026-06-30T19:28:29.3356289",
"ObjectInfo": {
"ID": "293263b9-c312-4bc6-bc27-545902ba1474",
"IntID": 0,
"Type": -1,
"Valid": false,
"IsEmpty": false
}
}
],
"LastHandled": "2026-06-30T19:28:29.3042258+10:00",
"ActionRequired": true,
"ObjectInfo": {
"ID": "db57a529-4c67-41dd-9a4e-f4d8cdf2bb3a",
"IntID": 0,
"Type": 800,
"Valid": true,
"IsEmpty": false
},
"ID": "db57a529-4c67-41dd-9a4e-f4d8cdf2bb3a",
"IntID": 0,
"CreateDt": "2026-06-30T19:28:29.3199419",
"UpdateDt": "2026-06-30T19:28:29.3356289"
}
application/x-www-form-urlencoded
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
{
"Alerts": [
{
"ID": "86b34e3a-c44d-4223-b3b0-1d727ec80481",
"LastHandled": "2026-06-30T19:28:29.3513411+10:00",
"Message": "sample string 2",
"AlertType": 0,
"AlertDate": "2026-06-30T19:28:29.3513411+10:00",
"RepeatCounter": 4,
"Category": "sample string 5",
"SubCategory": "sample string 6",
"IsEmail": true,
"IsSMS": true,
"RequiresAcknowledgement": true,
"AcknowledgedDate": "2026-06-30T19:28:29.3513411+10:00",
"AcknowledgementUserId": "19aa0c4d-391c-4426-ab5f-df7a653a625f",
"ResendWaitTimeMinutes": 10,
"ObjectType": 10,
"ObjectId": "2cfdc729-53c0-4a32-98cd-1fee705465c7",
"IgnoreDate": "2026-06-30T19:28:29.3513411+10:00",
"SourceID": 1,
"SourceType": 0,
"AlertRecipients": [
{
"AlertId": "57b62969-a84b-4cde-975e-fb3598ee9dbf",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-06-30T19:28:29.3513411+10:00",
"SMSSent": "2026-06-30T19:28:29.3513411+10:00"
},
{
"AlertId": "57b62969-a84b-4cde-975e-fb3598ee9dbf",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-06-30T19:28:29.3513411+10:00",
"SMSSent": "2026-06-30T19:28:29.3513411+10:00"
}
]
},
{
"ID": "86b34e3a-c44d-4223-b3b0-1d727ec80481",
"LastHandled": "2026-06-30T19:28:29.3513411+10:00",
"Message": "sample string 2",
"AlertType": 0,
"AlertDate": "2026-06-30T19:28:29.3513411+10:00",
"RepeatCounter": 4,
"Category": "sample string 5",
"SubCategory": "sample string 6",
"IsEmail": true,
"IsSMS": true,
"RequiresAcknowledgement": true,
"AcknowledgedDate": "2026-06-30T19:28:29.3513411+10:00",
"AcknowledgementUserId": "19aa0c4d-391c-4426-ab5f-df7a653a625f",
"ResendWaitTimeMinutes": 10,
"ObjectType": 10,
"ObjectId": "2cfdc729-53c0-4a32-98cd-1fee705465c7",
"IgnoreDate": "2026-06-30T19:28:29.3513411+10:00",
"SourceID": 1,
"SourceType": 0,
"AlertRecipients": [
{
"AlertId": "57b62969-a84b-4cde-975e-fb3598ee9dbf",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-06-30T19:28:29.3513411+10:00",
"SMSSent": "2026-06-30T19:28:29.3513411+10:00"
},
{
"AlertId": "57b62969-a84b-4cde-975e-fb3598ee9dbf",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-06-30T19:28:29.3513411+10:00",
"SMSSent": "2026-06-30T19:28:29.3513411+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-06-30T19:28:29.3513411+10:00",
"BuildDateUTC": "2026-06-30T19:28:29.3513411+10:00"
},
"VersionInformation": {
"Major": 1,
"Minor": 8,
"Hotfix": 0,
"Beta": true,
"Version": "1.8.0.BETA"
}
}