POST api/ConfiguredAlert

Creates a new instance of an ConfiguredAlert in the database.

Request Information

URI Parameters

None.

Body Parameters

The model to use

Name	Type	Additional information
ID	integer	None.
Enabled	boolean	None.
OwnerID	integer	None.
OwnerType	OwnerType	None.
AlertType	AlertType	None.
MaxRepeats	integer	None.
WaitTime	integer	None.
Type	ConfiguredAlertType	None.
CheckInControlled	boolean	None.
ID	integer	None.
Enabled	boolean	None.
Name	string	None.
Description	string	None.
AlertType	AlertType	None.
MaxRepeats	integer	None.
WaitTime	integer	None.
OwnerID	integer	None.
OwnerType	OwnerType	None.
Type	ConfiguredAlertType	None.
CheckInControlled	boolean	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "ID": 1,
  "Enabled": true,
  "OwnerID": 1,
  "OwnerType": 10,
  "AlertType": 0,
  "MaxRepeats": 1,
  "WaitTime": 1,
  "Type": 0,
  "CheckInControlled": true,
  "Name": "sample string 3",
  "Description": "sample string 4"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Http Status code indicating result.

GetConfiguredAlertResponse

Name	Description	Type	Additional information
ConfiguredAlerts	Array of Configured Alerts	Collection of ConfiguredAlert	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:

{
  "ConfiguredAlerts": [
    {
      "ID": 1,
      "Enabled": true,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "AlertType": 0,
      "MaxRepeats": 5,
      "WaitTime": 6,
      "OwnerID": 7,
      "OwnerType": 10,
      "Type": 0,
      "CheckInControlled": true
    },
    {
      "ID": 1,
      "Enabled": true,
      "Name": "sample string 3",
      "Description": "sample string 4",
      "AlertType": 0,
      "MaxRepeats": 5,
      "WaitTime": 6,
      "OwnerID": 7,
      "OwnerType": 10,
      "Type": 0,
      "CheckInControlled": 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:28:38.2524331+10:00",
    "BuildDateUTC": "2025-11-09T21:28:38.2524331+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 3,
    "Hotfix": 7,
    "Beta": false,
    "Version": "1.3.7"
  }
}

application/xml, text/xml

Sample:

<GetConfiguredAlertResponse 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:28:38.2524331+10:00</d2p1:BuildDateUTC>
    <d2p1:CurrentTimeUTC>2025-11-09T21:28:38.2524331+10:00</d2p1:CurrentTimeUTC>
  </ServerInformation>
  <VersionInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Services.Metadata" />
  <ConfiguredAlerts xmlns:d2p1="http://schemas.datacontract.org/2004/07/RimikAPI.Models">
    <d2p1:APIStructs.ConfiguredAlert>
      <d2p1:AlertType>Message</d2p1:AlertType>
      <d2p1:CheckInControlled>true</d2p1:CheckInControlled>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:MaxRepeats>5</d2p1:MaxRepeats>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:OwnerID>7</d2p1:OwnerID>
      <d2p1:OwnerType>Device</d2p1:OwnerType>
      <d2p1:Type>None</d2p1:Type>
      <d2p1:WaitTime>6</d2p1:WaitTime>
    </d2p1:APIStructs.ConfiguredAlert>
    <d2p1:APIStructs.ConfiguredAlert>
      <d2p1:AlertType>Message</d2p1:AlertType>
      <d2p1:CheckInControlled>true</d2p1:CheckInControlled>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:Enabled>true</d2p1:Enabled>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:MaxRepeats>5</d2p1:MaxRepeats>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:OwnerID>7</d2p1:OwnerID>
      <d2p1:OwnerType>Device</d2p1:OwnerType>
      <d2p1:Type>None</d2p1:Type>
      <d2p1:WaitTime>6</d2p1:WaitTime>
    </d2p1:APIStructs.ConfiguredAlert>
  </ConfiguredAlerts>
</GetConfiguredAlertResponse>