Reference for GetAgentAlertsSettings

Url: events/config/agents/{agentId}

HTTP Method: GET

Message direction	Format	Body
Request	XML	Example,Schema
Response	XML	Example,Schema

The following is an example request XML body:

No Xml request body for this method. False

The following is an example response XML body:

<?xml version="1.0" encoding="utf-16"?>
<agentAlertSettings xmlns="http://apprecovery.com/management/api/2010/05">
  <agentAlertingsPolicy>
    <alertNotificationGroup>
      <alertNotificationSettings>
        <enabled>true</enabled>
      </alertNotificationSettings>
      <description>String content</description>
      <emailNotificationSettings>
        <enabled>true</enabled>
        <bccAddresses>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
        </bccAddresses>
        <ccAddresses>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
        </ccAddresses>
        <toAddresses>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
        </toAddresses>
      </emailNotificationSettings>
      <enabledEvents>
        <enabledEvent>
          <event>String content</event>
        </enabledEvent>
        <enabledEvent>
          <event>String content</event>
        </enabledEvent>
      </enabledEvents>
      <name>String content</name>
      <serviceJobsNotificationSettings>
        <enabled>true</enabled>
      </serviceJobsNotificationSettings>
      <snmpNotificationSettings>
        <enabled>true</enabled>
        <specific>2147483647</specific>
      </snmpNotificationSettings>
      <syslogNotificationSettings>
        <enabled>true</enabled>
        <hostName>String content</hostName>
        <portNumber>2147483647</portNumber>
        <protocolVersion>2147483647</protocolVersion>
      </syslogNotificationSettings>
      <toastNotificationSettings>
        <enabled>true</enabled>
      </toastNotificationSettings>
      <windowsEventLogNotificationSettings>
        <enabled>true</enabled>
      </windowsEventLogNotificationSettings>
    </alertNotificationGroup>
    <alertNotificationGroup>
      <alertNotificationSettings>
        <enabled>true</enabled>
      </alertNotificationSettings>
      <description>String content</description>
      <emailNotificationSettings>
        <enabled>true</enabled>
        <bccAddresses>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
        </bccAddresses>
        <ccAddresses>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
        </ccAddresses>
        <toAddresses>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
          <emailAddress>
            <address>String content</address>
          </emailAddress>
        </toAddresses>
      </emailNotificationSettings>
      <enabledEvents>
        <enabledEvent>
          <event>String content</event>
        </enabledEvent>
        <enabledEvent>
          <event>String content</event>
        </enabledEvent>
      </enabledEvents>
      <name>String content</name>
      <serviceJobsNotificationSettings>
        <enabled>true</enabled>
      </serviceJobsNotificationSettings>
      <snmpNotificationSettings>
        <enabled>true</enabled>
        <specific>2147483647</specific>
      </snmpNotificationSettings>
      <syslogNotificationSettings>
        <enabled>true</enabled>
        <hostName>String content</hostName>
        <portNumber>2147483647</portNumber>
        <protocolVersion>2147483647</protocolVersion>
      </syslogNotificationSettings>
      <toastNotificationSettings>
        <enabled>true</enabled>
      </toastNotificationSettings>
      <windowsEventLogNotificationSettings>
        <enabled>true</enabled>
      </windowsEventLogNotificationSettings>
    </alertNotificationGroup>
  </agentAlertingsPolicy>
</agentAlertSettings>

The following is the request XML Schema:

The request body is empty.

The following is the response XML Schema:

<?xml version="1.0" encoding="utf-16"?>
<Schemas>
  <xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="anyType" nillable="true" type="xs:anyType" />
    <xs:element name="anyURI" nillable="true" type="xs:anyURI" />
    <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" />
    <xs:element name="boolean" nillable="true" type="xs:boolean" />
    <xs:element name="byte" nillable="true" type="xs:byte" />
    <xs:element name="dateTime" nillable="true" type="xs:dateTime" />
    <xs:element name="decimal" nillable="true" type="xs:decimal" />
    <xs:element name="double" nillable="true" type="xs:double" />
    <xs:element name="float" nillable="true" type="xs:float" />
    <xs:element name="int" nillable="true" type="xs:int" />
    <xs:element name="long" nillable="true" type="xs:long" />
    <xs:element name="QName" nillable="true" type="xs:QName" />
    <xs:element name="short" nillable="true" type="xs:short" />
    <xs:element name="string" nillable="true" type="xs:string" />
    <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" />
    <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" />
    <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" />
    <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" />
    <xs:element name="char" nillable="true" type="tns:char" />
    <xs:simpleType name="char">
      <xs:restriction base="xs:int" />
    </xs:simpleType>
    <xs:element name="duration" nillable="true" type="tns:duration" />
    <xs:simpleType name="duration">
      <xs:restriction base="xs:duration">
        <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" />
        <xs:minInclusive value="-P10675199DT2H48M5.4775808S" />
        <xs:maxInclusive value="P10675199DT2H48M5.4775807S" />
      </xs:restriction>
    </xs:simpleType>
    <xs:element name="guid" nillable="true" type="tns:guid" />
    <xs:simpleType name="guid">
      <xs:restriction base="xs:string">
        <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" />
      </xs:restriction>
    </xs:simpleType>
    <xs:attribute name="FactoryType" type="xs:QName" />
    <xs:attribute name="Id" type="xs:ID" />
    <xs:attribute name="Ref" type="xs:IDREF" />
  </xs:schema>
  <xs:schema xmlns:tns="http://apprecovery.com/management/api/2010/05" elementFormDefault="qualified" targetNamespace="http://apprecovery.com/management/api/2010/05" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:complexType name="agentAlertSettings">
      <xs:sequence>
        <xs:element minOccurs="0" name="agentAlertingsPolicy" nillable="true" type="tns:alertNotificationGroups">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
    <xs:element name="agentAlertSettings" nillable="true" type="tns:agentAlertSettings" />
    <xs:complexType name="alertNotificationGroups">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="alertNotificationGroup" nillable="true" type="tns:alertNotificationGroup" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="alertNotificationGroups" nillable="true" type="tns:alertNotificationGroups" />
    <xs:complexType name="alertNotificationGroup">
      <xs:sequence>
        <xs:element minOccurs="0" name="alertNotificationSettings" nillable="true" type="tns:alertNotificationOptions">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="description" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="emailNotificationSettings" nillable="true" type="tns:emailAlertNotificationOptions">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="enabledEvents" nillable="true" type="tns:enabledEvents" />
        <xs:element minOccurs="0" name="name" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="serviceJobsNotificationSettings" nillable="true" type="tns:serviceJobsNotificationOptions">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="snmpNotificationSettings" nillable="true" type="tns:snmpAlertNotificationOptions">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="syslogNotificationSettings" nillable="true" type="tns:syslogAlertNotificationOptions">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="toastNotificationSettings" nillable="true" type="tns:toastAlertNotificationOptions">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="windowsEventLogNotificationSettings" nillable="true" type="tns:windowsEventLogAlertNotificationOptions">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
    <xs:element name="alertNotificationGroup" nillable="true" type="tns:alertNotificationGroup" />
    <xs:complexType name="alertNotificationOptions">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:alertNotificationOptionsBase">
          <xs:sequence />
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="alertNotificationOptions" nillable="true" type="tns:alertNotificationOptions" />
    <xs:complexType name="alertNotificationOptionsBase">
      <xs:sequence>
        <xs:element minOccurs="0" name="enabled" type="xs:boolean" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="alertNotificationOptionsBase" nillable="true" type="tns:alertNotificationOptionsBase" />
    <xs:complexType name="emailAlertNotificationOptions">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:alertNotificationOptionsBase">
          <xs:sequence>
            <xs:element minOccurs="0" name="bccAddresses" nillable="true" type="tns:emailAddressesCollection" />
            <xs:element minOccurs="0" name="ccAddresses" nillable="true" type="tns:emailAddressesCollection" />
            <xs:element minOccurs="0" name="toAddresses" nillable="true" type="tns:emailAddressesCollection" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="emailAlertNotificationOptions" nillable="true" type="tns:emailAlertNotificationOptions" />
    <xs:complexType name="emailAddressesCollection">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="emailAddress" nillable="true" type="tns:emailAddress" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="emailAddressesCollection" nillable="true" type="tns:emailAddressesCollection" />
    <xs:complexType name="emailAddress">
      <xs:sequence>
        <xs:element minOccurs="0" name="address" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="emailAddress" nillable="true" type="tns:emailAddress" />
    <xs:complexType name="enabledEvents">
      <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="enabledEvent" nillable="true" type="tns:eventItem" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="enabledEvents" nillable="true" type="tns:enabledEvents" />
    <xs:complexType name="eventItem">
      <xs:sequence>
        <xs:element minOccurs="0" name="event" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:complexType>
    <xs:element name="eventItem" nillable="true" type="tns:eventItem" />
    <xs:complexType name="serviceJobsNotificationOptions">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:alertNotificationOptionsBase">
          <xs:sequence />
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="serviceJobsNotificationOptions" nillable="true" type="tns:serviceJobsNotificationOptions" />
    <xs:complexType name="snmpAlertNotificationOptions">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:alertNotificationOptionsBase">
          <xs:sequence>
            <xs:element minOccurs="0" name="specific" type="xs:int" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="snmpAlertNotificationOptions" nillable="true" type="tns:snmpAlertNotificationOptions" />
    <xs:complexType name="syslogAlertNotificationOptions">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:alertNotificationOptionsBase">
          <xs:sequence>
            <xs:element minOccurs="0" name="hostName" nillable="true" type="xs:string" />
            <xs:element minOccurs="0" name="portNumber" type="xs:int" />
            <xs:element minOccurs="0" name="protocolVersion" type="xs:int" />
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="syslogAlertNotificationOptions" nillable="true" type="tns:syslogAlertNotificationOptions" />
    <xs:complexType name="toastAlertNotificationOptions">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:alertNotificationOptionsBase">
          <xs:sequence />
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="toastAlertNotificationOptions" nillable="true" type="tns:toastAlertNotificationOptions" />
    <xs:complexType name="windowsEventLogAlertNotificationOptions">
      <xs:complexContent mixed="false">
        <xs:extension base="tns:alertNotificationOptionsBase">
          <xs:sequence />
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:element name="windowsEventLogAlertNotificationOptions" nillable="true" type="tns:windowsEventLogAlertNotificationOptions" />
  </xs:schema>
</Schemas>