GetLMAlertStates

This web method retrieves the complete alert states for all MBG monitors of a specific type.

Request parameters

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

https://gpn.webservice.gomez.com/AlertManagementService20/AlertManagementWS.asmx/GetLMAlertStates?username=string&password=string&monitorType=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

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 MBG monitor class.

Response XML

This web service method returns information according to its operation status.

If the web service operation fails, the FAILED status and an error message are returned in the following XML format:

<lastmileAlertStateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                            xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                            xmlns="http://gomeznetworks.com/webservices/">
  <status>FAILED</status>
  <errorMessage>Invalid Account Specified</errorMessage>
</lastmileAlertStateResponse>

If the web service operation succeeds, the information requested is returned in the following XML format:

<?xml version="1.0" encoding="utf-8"?>
<lastmileAlertStateResponse 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>
  <mbgmonitor id="16067" desc="WH-MobileScript-MobileLocation - Mobile Agent" doSummary="false"
              doComponents="true" timeoutInSec="300" class="PP_TRANSACTION" status="ACTIVE">
    <alertState alertId="102" alertType="Response Time Failure" alertState="SEVERE"
                respAlertType="Average" avgResponseTimeInMS="12363" warningCount="0" severeCount="0"
                goodCount="1" totalCount="1" />
    <alertState alertId="101" alertType="Transaction Failure" alertState="GOOD"
                avgResponseTimeInMS="14714" warningCount="0" severeCount="0" goodCount="4"
                totalCount="4" />
  </mbgmonitor>
  <mbgmonitor id="16121" desc="mobile-demo-amazon - 27-Sep-2013 2:43:44 - 1 - Mobile Agent"
              doSummary="false" doComponents="true" timeoutInSec="300" class="PP_TRANSACTION"
              status="ACTIVE">
    <alertState alertId="101" alertType="Transaction Failure" alertState="GOOD" avgResponseTimeInMS="0"
                warningCount="0" severeCount="0" goodCount="1" totalCount="2" />
    <alertState alertId="102" alertType="Response Time Failure" alertState="GOOD" respAlertType="Dynamic"
                avgResponseTimeInMS="6971" warningCount="0" severeCount="0" goodCount="1"
                totalCount="1" />
  </mbgmonitor>
  <mbgmonitor id="16173" desc="Timeout Script_Mobile - Mobile Agent" doSummary="false"
              doComponents="true" timeoutInSec="300" class="PP_TRANSACTION" status="ACTIVE">
    <alertState alertId="101" alertType="Transaction Failure" alertState="GOOD"
                avgResponseTimeInMS="10950" warningCount="0" severeCount="0" goodCount="1"
                totalCount="2" />
  </mbgmonitor>
  <mbgmonitor id="16291" desc="mobile_fail_test - 28-Aug-2014 19:37:27 - 2 - Mobile Agent"
              doSummary="false" doComponents="true" timeoutInSec="300" class="PP_TRANSACTION"
              status="ACTIVE">
    <alertState alertId="102" alertType="Response Time Failure" alertState="SEVERE"
                respAlertType="Static" avgResponseTimeInMS="0" warningCount="0" severeCount="1"
                goodCount="0" totalCount="1" />
  </mbgmonitor>
  <mbgmonitor id="16344" desc="Mobile-Huan-Alerting - 1 - Mobile Agent" doSummary="false"
              doComponents="true" timeoutInSec="300" class="PP_TRANSACTION" status="ACTIVE">
    <alertState alertId="102" alertType="Response Time Failure" alertState="SEVERE"
                respAlertType="Static" avgResponseTimeInMS="4464" warningCount="0" severeCount="1"
                goodCount="1" totalCount="1" />
  </mbgmonitor>
  <mbgmonitor id="16346" desc="Mobile-WangHuan-Alerting-Average - Mobile Agent" doSummary="false"
              doComponents="true" timeoutInSec="300" class="PP_TRANSACTION" status="ACTIVE">
    <alertState alertId="102" alertType="Response Time Failure" alertState="SEVERE"
                respAlertType="Average" avgResponseTimeInMS="5115" warningCount="0" severeCount="0"
                goodCount="1" totalCount="1" />
  </mbgmonitor>
</lastmileAlertStateResponse>

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
<lastmileAlertStateResponse> Top-level container of the XML response of this web service none <status> <errorMessage> <mbgmonitor>
<status> SUCCESS | FAILED <lastmileAlertStateResponse> none
<errorMessage> Detailed error message if status="FAILED" <lastmileAlertStateResponse> none
<mbgmonitor> Container for monitor summary information and the set of the pages and sites where the monitor is in an alert state <lastmileAlertStateResponse> <alertState>
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
<alertState> Container for alert summary information <mbgmonitor>
alertId The following integral values are possible for the different alert types:
  • 101—Transaction Failure
  • 102—Response Time Failure
alertType The following values correspond to alertId values:
  • Transaction Failure (alertId=101)
  • Response Time Failure (alertId=102)
alertState The following values for the current state of the alert are possible:
  • Good—No user-specified criteria has been violated.
  • Bad—Indicates a violation of non-response-time criteria.
  • Warning—Indicates a violation of user-specified response time criteria.
  • Severe—Indicates a violation of user-specified response time criteria.
respAlertType The following values are possible:
  • Average
  • DYNAMIC
  • Static
avgResponseTimeInMS Average response time in milliseconds
warningCount Warning alert count for current alert type of the MBG monitor
severeCount Severe alert count for current alert type of the MBG monitor
goodCount Good alert count for current alert type of the MBG monitor
totalCount Total alert count for current alert type of the MBG monitor