GetReferencingMonitors

Use this method to retrieve a set of the non-deleted tests that reference the specified monitor.

Request parameters

You can use either a SOAP or HTTP call for this method. To call this web service from the browser, submit the following Get Request:

http://gpn.webservice.gomez.com/AccountManagementWS_20/AccountManagementWS.asmx/GetReferencingMonitors?sUsername=string&sPassword=string&iMonitorId=int

After specifying the following parameters:

  • sUsername – The account username
  • sPassword – The account password
  • iMonitorId - The test identifier—This is the test run from a remote agent location. The complete set of monitor identifiers available for an account can be retrieved using the GetAccountMonitors or GetAccountMonitors2 method.

Validation criteria

  • sUsername is valid for an account.
  • sPassword is valid for the specified username.

For more information, see Retrieving Specific Account Management Data.

Response XML

STATUS_FAILED

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

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
 <GetReferencingMonitorsResponse
  xmlns="http://gomeznetworks.com/webservices/">
  <GetReferencingMonitorsResult>
     <Status>
      <eStatus>STATUS_FAILED</eStatus>
      <sErrorMessage>INVALID ACCOUNT</sErrorMessage>
     </Status>
   </GetReferencingMonitorsResult>
  </GetReferencingMonitorsResponse>
 </soap:Body>
</soap:Envelope

SUCCESS

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

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
 <GetReferencingMonitorsResponse
  xmlns="http://gomeznetworks.com/webservices/">
  <GetReferencingMonitorsResult>
     <Status>
  <eStatus>STATUS_SUCCESS</eStatus>
  <sErrorMessage />
  </Status>
 <MonitorSet>
  <Monitor mid="1162745" desc="yoohoo_single_URL"
   url="http://www.yoohoo.com" class="MONITOR"
   status="INACTIVE" account="12102" timeoutinsec="300"
   frequencyinms="300" docomponents="1"
   created="5/19/2008 3:22:55 PM" modified="5/3/2014 2:01:09 PM" />
  <Monitor mid="1162690" desc="yoohoo_transaction_all"
   url="" class="TRANSACTION" status="ACTIVE" account="12102"
   timeoutinsec="300" frequencyinms="300" docomponents="1"
   created="5/19/2008 2:37:47 PM" modified="5/3/2014 1:52:50 PM" />
  </MonitorSet>
   </GetReferencingMonitorsResult>
  </GetReferencingMonitorsResponse>
 </soap:Body>
</soap:Envelope

Output

The following table summarizes the main elements, attributes, and possible attribute values in the XML response returned by this web service. Retrieve the WDSL for the complete definition of this XML response. For more information, see Retrieving Account Management Data.

Attribute Description Parent Element Child Elements
<GetReferencingMonitorsResponse> Top-level container for the XML response of this web service None <Status> <MonitorSet>
<Status> The container for the information about the status of the operation <GetReferencingMonitorsResponse> <eStatus> <sErrorMessage>
<eStatus> STATUS_SUCCESS STATUS_FAILED STATUS_DATA_NOT_READY <Status> None
<sErrorMessage> A detailed error message if the status is STATUS_FAILED <Status> None
<MonitorSet> The container for the account summary information <GetReferencingMonitorsResponse> None
<Monitor> The container for information about an individual test <MonitorSet> None
mid The unique identifier for the test
desc The description of the test
url The URL that is being tested
class The type of test:
  • MONITOR
  • TRANSACTION
status The status of the test:
  • ACTIVE
  • INACTIVE
account The ID of the account that created the test
timeoutinsec The length of time, in seconds, before a test times out on retry
frequencyinms The interval, in milliseconds, between the test runs
docomponents
  1. If components are downloaded
  2. Otherwise
created The date the test was created
modified The last time the test was modified

Other SOAP and HTTP examples

http://gpn.webservice.gomez.com/AccountManagementWS_20/AccountManagementWS.asmx?op=GetReferencingMonitors