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. |
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-05-07T23:07:39.3761272+10:00",
"AcknowledgementUserID": "3e19f5ed-ab2c-4ac0-bdb4-2cd6c9b99d2f",
"AlertDate": "2026-05-07T23:07:39.3917511",
"ResendWaitTimeMinutes": 9,
"MaxRepeat": 10,
"ObjectID": "5286e02b-96aa-454d-8fd8-7191bb0d463f",
"ObjectType": 10,
"IgnoreDate": "2026-05-07T23:07:39.3761272+10:00",
"SourceID": "c982ae17-7333-4e22-a2b6-bc87b3aceec9",
"SourceIntID": 12,
"SourceType": 0,
"SourceInfo": "ReadingBand 12",
"GoodCounter": 13,
"AlertRecipients": [
{
"AlertID": "2762ae22-0259-480f-b65c-9e63801fee2b",
"UserID": "7fca7e67-259d-4a23-9594-d8859a930abf",
"EmailSent": "2026-05-07T23:07:39.3761272+10:00",
"SMSSent": "2026-05-07T23:07:39.3761272+10:00",
"GetsEmail": true,
"GetsSMS": true,
"ID": "3a0523b8-6622-436e-b118-a2be45c8dee0",
"IntID": 0,
"ObjectInfo": {
"ID": "3a0523b8-6622-436e-b118-a2be45c8dee0",
"IntID": 0,
"Type": -1,
"Valid": false,
"IsEmpty": false
}
},
{
"AlertID": "2762ae22-0259-480f-b65c-9e63801fee2b",
"UserID": "7fca7e67-259d-4a23-9594-d8859a930abf",
"EmailSent": "2026-05-07T23:07:39.3761272+10:00",
"SMSSent": "2026-05-07T23:07:39.3761272+10:00",
"GetsEmail": true,
"GetsSMS": true,
"ID": "3a0523b8-6622-436e-b118-a2be45c8dee0",
"IntID": 0,
"ObjectInfo": {
"ID": "3a0523b8-6622-436e-b118-a2be45c8dee0",
"IntID": 0,
"Type": -1,
"Valid": false,
"IsEmpty": false
}
}
],
"LastHandled": "2026-05-07T23:07:39.3761272+10:00",
"ActionRequired": true,
"ObjectInfo": {
"ID": "8e58daf5-0460-4986-8133-627cd415c9a0",
"IntID": 0,
"Type": 800,
"Valid": true,
"IsEmpty": false
},
"ID": "8e58daf5-0460-4986-8133-627cd415c9a0",
"IntID": 0
}
application/x-www-form-urlencoded
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
{
"Alerts": [
{
"ID": "e3f1a8bf-1061-40b7-ad82-8004b174614c",
"LastHandled": "2026-05-07T23:07:39.4386233+10:00",
"Message": "sample string 2",
"AlertType": 0,
"AlertDate": "2026-05-07T23:07:39.4386233+10:00",
"RepeatCounter": 4,
"Category": "sample string 5",
"SubCategory": "sample string 6",
"IsEmail": true,
"IsSMS": true,
"RequiresAcknowledgement": true,
"AcknowledgedDate": "2026-05-07T23:07:39.4386233+10:00",
"AcknowledgementUserId": "27e0b7f7-4079-4432-bd9e-63ff32cd403d",
"ResendWaitTimeMinutes": 10,
"ObjectType": 10,
"ObjectId": "3eb74e3e-70bc-4f63-8a77-4c4629a3b31a",
"IgnoreDate": "2026-05-07T23:07:39.4386233+10:00",
"SourceID": 1,
"SourceType": 0,
"AlertRecipients": [
{
"AlertId": "260febda-3791-479a-9ce7-b120b1614b38",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-05-07T23:07:39.4386233+10:00",
"SMSSent": "2026-05-07T23:07:39.4386233+10:00"
},
{
"AlertId": "260febda-3791-479a-9ce7-b120b1614b38",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-05-07T23:07:39.4386233+10:00",
"SMSSent": "2026-05-07T23:07:39.4386233+10:00"
}
]
},
{
"ID": "e3f1a8bf-1061-40b7-ad82-8004b174614c",
"LastHandled": "2026-05-07T23:07:39.4386233+10:00",
"Message": "sample string 2",
"AlertType": 0,
"AlertDate": "2026-05-07T23:07:39.4386233+10:00",
"RepeatCounter": 4,
"Category": "sample string 5",
"SubCategory": "sample string 6",
"IsEmail": true,
"IsSMS": true,
"RequiresAcknowledgement": true,
"AcknowledgedDate": "2026-05-07T23:07:39.4386233+10:00",
"AcknowledgementUserId": "27e0b7f7-4079-4432-bd9e-63ff32cd403d",
"ResendWaitTimeMinutes": 10,
"ObjectType": 10,
"ObjectId": "3eb74e3e-70bc-4f63-8a77-4c4629a3b31a",
"IgnoreDate": "2026-05-07T23:07:39.4386233+10:00",
"SourceID": 1,
"SourceType": 0,
"AlertRecipients": [
{
"AlertId": "260febda-3791-479a-9ce7-b120b1614b38",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-05-07T23:07:39.4386233+10:00",
"SMSSent": "2026-05-07T23:07:39.4386233+10:00"
},
{
"AlertId": "260febda-3791-479a-9ce7-b120b1614b38",
"GetsEmail": true,
"GetsSMS": true,
"EmailSent": "2026-05-07T23:07:39.4386233+10:00",
"SMSSent": "2026-05-07T23:07:39.4386233+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-05-07T23:07:39.4386233+10:00",
"BuildDateUTC": "2026-05-07T23:07:39.4386233+10:00"
},
"VersionInformation": {
"Major": 1,
"Minor": 8,
"Hotfix": 0,
"Beta": true,
"Version": "1.8.0.BETA"
}
}