alertResponse Type

alertResponse is returned for all alert operations except getList and getListRemote.

alertResponse always contains the following common elements:

  • authToken
  • resultCount
  • statusCode
  • statusMessage
  • summaryOnly

If resultCount is 1 and statusCode is 2000 (successful), the resultSet element is included after resultCount listing the following Alert details:

  • alertType
  • name
  • desc
  • priority
  • enabled
  • devices
  • users
  • traps
  • resetTime
  • trackIndividualDevice
  • alertRules
  • snmpOId (createAlert and createAlertRemote only)
  • changeNameTo (updateAlert and updateAlertRemote only)
Note: The Alert-Specific Request parameters specified in the alertRules parameter are also returned. The response depends on the alert type used.

If resultCount is 0 and statusCode is not 2000 (successful), an error is returned in statusMessage.

Example

SOAP request for alertResponse Type: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:readAlertResponse xmlns:ns="AlertService">
         <ns:return xsi:type="ax27:AlertResponse" xmlns:ax27="http://alert.services.logapp.loglogic.com/xsd" xmlns:ax28="http://services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <ax28:authToken xsi:nil="true"/>
            <ax28:resultCount>1</ax28:resultCount>
            <ax28:statusCode>2000</ax28:statusCode>
            <ax28:statusMessage>Successful</ax28:statusMessage>
            <ax28:summaryOnly>false</ax28:summaryOnly>
            <ax27:resultSet xsi:type="ax27:AlertDetail">
               <ax27:alertRules>FewerThan/100//MoreThan/200</ax27:alertRules>
               <ax27:alertType>Adaptive Baseline Alert</ax27:alertType>
               <ax27:desc>hello there</ax27:desc>
               <ax27:devices>All Other UNIX</ax27:devices>
               <ax27:enabled>yes</ax27:enabled>
               <ax27:name>Myalert</ax27:name>
               <ax27:networkMonitorPolicyRules xsi:nil="true"/>
               <ax27:priority>Low</ax27:priority>
               <ax27:resetTime>900</ax27:resetTime>
               <ax27:snmpOId/>
               <ax27:trackIndividualDevice>yes</ax27:trackIndividualDevice>
               <ax27:users>admin</ax27:users>
            </ax27:resultSet>
         </ns:return>
      </ns:readAlertResponse>
   </soapenv:Body>
</soapenv:Envelope>