POST api/AlertSubscriptions

Creates a new instance of an AlertSubscription in the database.

Request Information

URI Parameters

None.

Body Parameters

The Alert Subscription to use

Name	Description	Type	Additional information
Enabled	Whether or not this subscription is Enabled	boolean	None.
Username	The Username for who this subscription is for	string	None.
ObjectID	The Integer ID of the object this subscription is for	integer	None.
ObjectType	The object Type	OwnerType	None.
AlertTypeThreshold	The threshold for creating an Alert in this subscription	AlertType	None.
IncludeChildObjects	Whether or not this Subscription includes any child objects beneath the object	boolean	None.
ReceiveEmail	Whether or not this Subscription elicits an Email	boolean	None.
ReceiveSMS	Whether or not this Subscription elicits an SMS	boolean	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "Enabled": true,
  "Username": "sample string 2",
  "ObjectID": 3,
  "ObjectType": 10,
  "AlertTypeThreshold": 0,
  "IncludeChildObjects": true,
  "ReceiveEmail": true,
  "ReceiveSMS": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Http Status code indicating result.

GetAlertSubscriptionResponse

Name	Description	Type	Additional information
AlertSubscriptions	Array of Alerts	Collection of AlertSubscription	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:

{
  "AlertSubscriptions": [
    {
      "ID": 1,
      "Enabled": true,
      "Username": "sample string 3",
      "ObjectName": "sample string 4",
      "ObjectID": 5,
      "ObjectType": 10,
      "AlertTypeThreshold": 0,
      "IncludeChildObjects": true,
      "ReceiveEmail": true,
      "ReceiveSMS": true
    },
    {
      "ID": 1,
      "Enabled": true,
      "Username": "sample string 3",
      "ObjectName": "sample string 4",
      "ObjectID": 5,
      "ObjectType": 10,
      "AlertTypeThreshold": 0,
      "IncludeChildObjects": true,
      "ReceiveEmail": true,
      "ReceiveSMS": true
    }
  ],
  "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:09.5988869+10:00",
    "BuildDateUTC": "2025-11-09T21:42:09.5988869+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  }
}