GetMonitorSites

Use this method to retrieve a complete set of the monitor sites (nodes) configured to run the specified Backbone monitor (test).

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/GetMonitorSites?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 Backbone monitor identifiers available for an account can be retrieved using the GetAccountMonitors method. MBGmonitors that can be retrieved through GetAccountMonitors2 are not supported by this method.

Validation criteria

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

For more information, see Retrieving Specific Account Management Data.

Response XML

This web service returns the following information according to its operation status:

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>
    <GetMonitorSites
       xmlns="http://gomeznetworks.com/webservices/">
 <Status>
  <eStatus>STATUS_FAILED</eStatus>
  <sErrorMessage>INVALID MONITOR FOR ACCOUNT</sErrorMessage>
  </Status>
   </GetMonitorSitesResult>
  </GetMonitorSitesResponse>
 </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>
    <GetMonitorSites
       xmlns="http://gomeznetworks.com/webservices/">
   <Status>
    <eStatus>STATUS_SUCCESS</eStatus>
    <sErrorMessage />
   </Status>
  <SiteSet>
   <Site sid="105" name="Newark, NJ  Qwest" status="ACTIVE"
    city="Newark" state="NJ" country="US"
    IP="63.236.80.118" backboneId="14" backbone="Qwest" isURL="1"
    isEmpirix="0" isUTA="1" />
   <Site sid="110" name="San Jose, CA  Verizon (MCI)"
    status="ACTIVE" city="San Jose" state="CA" country="US"
    IP="204.176.100.28" backboneId="21" backbone="Verizon (MCI)"
    isURL="1" isEmpirix="0" isUTA="1" />
   <Site sid="111" name="Atlanta, GA  Verizon (MCI)"
    status="ACTIVE" city="Atlanta" state="GA" country="US"
    IP="198.5.135.27" backboneId="21" backbone="Verizon (MCI)"
    isURL="1" isEmpirix="0" isUTA="1" />
   <Site sid="112" name="London, UK  Verizon (MCI)"
    status="INACTIVE" city="London" state="" country="GB"
    IP="194.129.73.27" backboneId="21" backbone="Verizon (MCI)"
    isURL="1" isEmpirix="0" isUTA="1" />
   <Site sid="113" name="Atlanta, GA  Internap" status="ACTIVE"
    city="Atlanta" state="GA" country="US" IP="216.52.195.58"
    backboneId="8" backbone="InterNap"
    isURL="1" isEmpirix="0" isUTA="1" />
   <Site sid="115" name="St. Louis, MO  SAVVIS" status="ACTIVE"
    city="St. Louis" state="MO" country="US" IP="64.240.149.210"
    backboneId="24" backbone="SAVVIS"
    isURL="1" isEmpirix="0" isUTA="1" />
   <Site sid="116" name="Seattle, WA  SAVVIS" status="ACTIVE"
    city="Seattle" state="WA" country="US" IP="208.173.48.142"
    backboneId="24" backbone="SAVVIS"
    isURL="1" isEmpirix="0" isUTA="1" />
   <Site sid="117" name="Mesa, AZ  AT&T" status="ACTIVE"
    city="Mesa" state="AZ" country="US" IP="63.241.131.196"
    backboneId="5" backbone="AT&T" isURL="1" isEmpirix="0" isUTA="1" />
  …
  </SiteSet>
        </GetMonitorSitesResult>
    </GetMonitorSitesResponse>
  </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
<GetMonitorSitesResponse> Top-level container for the XML response of this web service None <Status> <SiteSet>
<Status> The container for the information about the status of the operation <GetMonitorSitesResponse> <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
<SiteSet> The container for the set of monitor sites configured for the account <GetMonitorSitesResponse> <Site>
<Site> The container for the information for an monitor site <SiteSet> None
sid The unique identifier for the site
name The name of the site
status The status of the site:
  • ACTIVE
  • INACTIVE
city The city where the site is located
state The state where the site is located
country The country where the site is located
ip The site's IP address
backboneID The site's Backbone ID
backbone The Backbone name
isURL The test is a single URL test.
  • 0 = NO
  • 1 = YES
isEmpirix The test is an Empirix test.
  • 0 = NO
  • 1 = YES
isUTA Indicates if the test is a UTA test.
  • 0 = NO
  • 1 = YES
Should be set to 0 (NO).

Other SOAP and HTTP examples

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