PUT api/AlertSubscriptions

Update AlertSubscription

Request Information

URI Parameters

None.

Body Parameters

AlertSubscription to update

Name	Description	Type	Additional information
ID	Alert Subscription integer ID to be updated	integer	None.
Username	The Username of the person subscribing	string	None.
ObjectID	The Integer ID of the Object to handle	integer	None.
ObjectType	The type of Object to handle	OwnerType	None.
AlertTypeThreshold	The threshold for when an alert shall be sent	AlertType	None.
IncludeChildObjects	Whether or not to include children objects under this object (i.e. include Devices under a DataNode)	boolean	None.
ReceiveEmail	Whether or not to receive an email for this subscription	boolean	None.
ReceiveSMS	Whether or not to receive an SMS for this subscription	boolean	None.
Enabled	Whether or not this subscription is enabled	boolean	None.

Request Formats

application/json, text/json, text/html

Sample:

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

application/xml, text/xml

Sample:

<APIStructs.Update_AlertSubscription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
  <AlertTypeThreshold>Message</AlertTypeThreshold>
  <Enabled>true</Enabled>
  <ID>1</ID>
  <IncludeChildObjects>true</IncludeChildObjects>
  <ObjectID>1</ObjectID>
  <ObjectType>Device</ObjectType>
  <ReceiveEmail>true</ReceiveEmail>
  <ReceiveSMS>true</ReceiveSMS>
  <Username>sample string 2</Username>
</APIStructs.Update_AlertSubscription>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated AlertSubscription and any messages

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:45:02.9137706+10:00",
    "BuildDateUTC": "2025-11-09T21:45:02.9137706+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml, text/xml

Sample:

<GetAlertSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RimikAPI.Models.Responses">
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services">
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
    <d2p1:Common.Message>
      <d2p1:CodeDesc>2</d2p1:CodeDesc>
      <d2p1:MessageCode>1</d2p1:MessageCode>
      <d2p1:MessageText>sample string 3</d2p1:MessageText>
      <d2p1:RecordNumber>4</d2p1:RecordNumber>
      <d2p1:Severity>Information</d2p1:Severity>
    </d2p1:Common.Message>
  </Messages>
  <ServerInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata">
    <d2p1:BuildDateUTC>2025-11-09T21:45:02.9137706+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:45:02.9137706+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <AlertSubscriptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
    <d2p1:APIStructs.AlertSubscription>
      <d2p1:AlertTypeThreshold>Message</d2p1:AlertTypeThreshold>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:IncludeChildObjects>true</d2p1:IncludeChildObjects>
      <d2p1:ObjectID>5</d2p1:ObjectID>
      <d2p1:ObjectName>sample string 4</d2p1:ObjectName>
      <d2p1:ObjectType>Device</d2p1:ObjectType>
      <d2p1:ReceiveEmail>true</d2p1:ReceiveEmail>
      <d2p1:ReceiveSMS>true</d2p1:ReceiveSMS>
      <d2p1:Username>sample string 3</d2p1:Username>
    </d2p1:APIStructs.AlertSubscription>
    <d2p1:APIStructs.AlertSubscription>
      <d2p1:AlertTypeThreshold>Message</d2p1:AlertTypeThreshold>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:IncludeChildObjects>true</d2p1:IncludeChildObjects>
      <d2p1:ObjectID>5</d2p1:ObjectID>
      <d2p1:ObjectName>sample string 4</d2p1:ObjectName>
      <d2p1:ObjectType>Device</d2p1:ObjectType>
      <d2p1:ReceiveEmail>true</d2p1:ReceiveEmail>
      <d2p1:ReceiveSMS>true</d2p1:ReceiveSMS>
      <d2p1:Username>sample string 3</d2p1:Username>
    </d2p1:APIStructs.AlertSubscription>
  </AlertSubscriptions>
</GetAlertSubscriptionResponse>