GetLMCompleteAlertConfiguration

This web method retrieves the complete alert configuration for all MBG monitors of a specific type and having a specific status.

Request parameters

To call this web service from your browser, submit the following HTTP Get Request:

https://gpn.webservice.gomez.com/AlertManagementService20/?AlertManagementWS.asmx/GetLMCompleteAlertConfiguration??username=string&password=string&monitorType=string&statusType=string

In the URL above, specify the following parameters:

  • username—The DPN account username
  • password—The DPN account password
  • monitorType—Specifies the class of MBG monitor data to retrieve. Specify one of the following values:
Value Description
ALL To return information for all monitor types ('PRIVATEPEER', 'MOBILE')
PRIVATEPEER To return information for PRIVATEPEER tests only
MOBILE To return information for MOBILE tests only
  • statusType—Specifies the status of the monitor data to retrieve. Specify one of the following values:
Value Description
ALL To return both ACTIVE and INACTIVE tests
ACTIVE To return only ACTIVE tests
INACTIVE To return only INACTIVE tests

Validation criteria

This web service uses the following criteria to validate the incoming request:

  • username is valid for an active account.

  • password is valid for the specified username.

  • monitorType specifies a valid monitor class.

  • statusType specifies a valid monitor status

Response XML

This web service method returns information according to its operation status. If the web service operation succeeds, the information requested is returned in the following XML format:

<?xml version="1.0" encoding="utf-8"?>
<lastMileAlertConfigurationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                                    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                                    xmlns="http://gomeznetworks.com/webservices/">
  <status>SUCCESS</status>
  <monitorAlertConfiguration id="14378" desc="SwethaMobileChangedOrderName" doSummary="false"
                             doComponents="true" timeoutInSec="300" class="PP_TRANSACTION"
                             status="ACTIVE">
    <alertConfigurations>
      <DynamicResponseTimeAlert alertId="102" isEnabled="false" isPersistent="false"
                                longTermResponseRangeInDays="1" shortTermResponseRangeInMinutes="60">
        <warningThreshold type="ABSOLUTE" value="15000" />
        <severeThreshold type="ABSOLUTE" value="20000" />
      </DynamicResponseTimeAlert>
      <DynamicResponseTimeAlert alertId="102" isEnabled="false" isPersistent="false"
                                longTermResponseRangeInDays="1" shortTermResponseRangeInMinutes="60">
        <warningThreshold type="ABSOLUTE" value="20000" />
        <severeThreshold type="ABSOLUTE" value="30000" />
      </DynamicResponseTimeAlert>
      <DynamicResponseTimeAlert alertId="102" isEnabled="false" isPersistent="false"
                                longTermResponseRangeInDays="1" shortTermResponseRangeInMinutes="60">
        <warningThreshold type="ABSOLUTE" value="10000" />
        <severeThreshold type="ABSOLUTE" value="20000" />
      </DynamicResponseTimeAlert>
      <DynamicResponseTimeAlert alertId="102" isEnabled="false" isPersistent="false"
                                longTermResponseRangeInDays="1" shortTermResponseRangeInMinutes="60">
        <warningThreshold type="ABSOLUTE" value="5000" />
        <severeThreshold type="ABSOLUTE" value="10000" />
      </DynamicResponseTimeAlert>
    </alertConfigurations>
  </monitorAlertConfiguration>
  <monitorAlertConfiguration id="16067" desc="WH-MobileScript-MobileLocation - Mobile Agent"
                             doSummary="false" doComponents="true" timeoutInSec="300"
                             class="PP_TRANSACTION" status="ACTIVE">
    <alertConfigurations>
      <TransactionAlert alertId="101" isEnabled="false" isPersistent="true"
                        persistenceIntervalInMin="5" />
      <AverageResponseTimeAlert alertId="102" isEnabled="false" isPersistent="true"
                                persistenceIntervalInMin="5" warningThresholdInMS="500"
                                severeThresholdInMS="1000" />
    </alertConfigurations>
  </monitorAlertConfiguration>
</lastMileAlertConfigurationResponse>

Output

The following table summarizes the main elements, attributes, and possible attribute values in the XML response returned by this web service. See the Alert Management WSDL for the complete definition of this XML response:

XML Elements & Attributes Description Parent Element Child Elements
<lastMileAlertConfigurationResponse> Top-level container of the XML response of this web service none <status> <errorMessage> <monitorAlertConfiguration>
<status> SUCCESS | FAILED <lastMileAlertConfigurationResponse> none
<errorMessage> Detailed error message if status="FAILED" <lastMileAlertConfigurationResponse> none
<monitorAlertConfiguration> Container of monitor summaries and DPN alert configurations associated with the monitor <lastMileAlertConfigurationResponse> <alertConfigurations>
id MBG monitor ID
desc MBG monitor description
doSummary True, if monitor is running in summary mode; false, otherwise
doComponents True, if monitor is collecting performance information for page components; false, otherwise
timeoutInSec The number of seconds before the monitor times out
class The type of test
status ACTIVE | INACTIVE | DELETE
<alertConfigurations> Container for the collection of alert configurations for a given monitor <monitorAlertConfiguration> <TransactionAlert> <DynamicResponseTimeAlert> <StaticResponseTimeAlert> <AverageResponseTimeAlert>
<TransactionAlert> Container for user-defined transaction alert configuration <alertConfigurations> none
alertId 101—Transaction Failure Alert
isEnabled TRUE, if alert is enabled; FALSE, otherwise
isPersistent TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin If isPersistent=TRUE, interval of time between alert sends
<DynamicResponseTimeAlert> Container for user-defined dynamic response time alert configuration <alertConfigurations> <warningThreshold> <severeThreshold>
alertId 102 – Response Time Failure
isEnabled TRUE, if alert is enabled; FALSE, otherwise
isPersistent TRUE, if alert is persistent; FALSE, otherwise
longTermResponseRangeInDays User-defined duration in days over which the long-term response time average is calculated
shortTermResponseRangeInMinutes User-defined time duration in minutes over which the short-term response time average is calculated
<StaticResponseTimeAlert> Container for user-defined static response time alert configuration <alertConfigurations> none
alertId 102—Response Time Failure
isEnabled TRUE, if alert is enabled; FALSE, otherwise
isPersistent TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin If isPersistent=TRUE, interval of time between alert sends
warningThresholdInMS User-defined response time warning threshold in milliseconds
severeThresholdInMS User-defined response time severe threshold in milliseconds
<AverageResponseTimeAlert> Container for user-defined average response time alert configuration <alertConfigurations> none
alertId 102—Response Time Failure
isEnabled TRUE, if alert is enabled; FALSE, otherwise
isPersistent TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin If isPersistent=TRUE, interval of time between alert sends
warningThresholdInMS User-defined response time warning threshold in milliseconds
severeThresholdInMS User-defined response time severe threshold in milliseconds
<warningThreshold> Container for user-defined warning alert criteria <DynamicResponseTimeAlert> none
type ABSOLUTE | PERCENT
value If type=ABSOLUTE, response time threshold in milliseconds to trigger an alert If type=PERCENT, percent of baseline response time required to trigger an alert
<severeThreshold> Container for user-defined severe alert criteria <DynamicResponseTimeAlert> none
type ABSOLUTE | PERCENT
value If type=ABSOLUTE, response time threshold in milliseconds to trigger an alert If type=PERCENT, percent of baseline response time required to trigger an alert