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
  • priorityName
  • enabled
  • deviceNames
  • usernames
  • trapIds
  • 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.