GetAccountPackageByMonitorClass

Use this method to retrieve a complete account configuration package for a type of 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/GetAccountPackageByMonitorClass?sPassword=string&sUsername=string&sMonitorClass=string

After specifying the following parameters:

  • sUsername – The account username
  • sPassword – The account password
  • sMonitorClass - Specify:
    • ALL
    • BROWSER
    • BROWSERBENCHMARK
    • BROWSERANDBENCHMARK
    • EMPIRIXTX
    • EMPIRIXTXBENCHMARK
    • EMPIRIXTXANDBENCHMARK
    • LM
    • LMMONITOR
    • LMTRANSACTION
    • PP
    • PPMONITOR
    • PPTRANSACTION
    • MOBILE
    • LMMOBILE
    • PPMOBILE
    • SINGLEURL
    • SINGLEURLBENCHMARK
    • SINGLEURLANDBENCHMARK
    • UTATX
    • UTATXBENCHMARK
    • UTATXANDBENCHMARK
    • TRANSACTION
    • TRANSACTIONBENCHMARK
    • TRANSACTIONANDBENCHMARK

Validation criteria

  • sUsername is valid for an account.
  • sPassword is valid for the specified username.
  • sMonitorClass is valid for the type of tests in your 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>
    <GetAccountPackageByMonitorClassResponse
     xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountPackageByMonitorClassResult>
        <Status>
          <eStatus>STATUS_FAILED</eStatus>
          <sErrorMessage>INVALID ACCOUNT SPECIFIED</sErrorMessage>
        </Status>
     </GetAccountPackageByMonitorClassResult>
    </GetAccountPackageByMonitorClassResponse>
  </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>
  <GetAccountPackageByMonitorClassResponse
     xmlns="http://gomeznetworks.com/webservices/">
  <GetAccountPackageByMonitorClassResult>
      <Status>
        <eStatus>STATUS_SUCCESS</eStatus>
        <sErrorMessage />
    </Status>
   <AccountInfo name="Jane Doe" title="Software Developer"
     first="Jane" last="Doe" username="jDoe" address1="One Campus Martius"
     address2="" city="Detroit" state="MI" zip="48226" email="jDoe@company.com"
     phone="(313) 5551212" fax="" gmtoffset="240" timezone=
     "(GMT 04:00) Eastern Daylight Savings Time" />
   <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" />
   </MonitorSet>
   <SiteSet>
   <Site sid="101" name="Denver, CO  Verizon (MCI)" status="ACTIVE"
    city="Denver" state="CO" country="US" IP="63.123.140.113"
    backboneId="21" backbone="Verizon (MCI)" isURL="1"
    isEmpirix="0" isUTA="1" />
   <Site sid="102" name="Dallas, TX  Qwest" status="INACTIVE"
    city="Dallas" state="TX" country="US" IP="65.112.180.178"
    backboneId="14" backbone="Qwest" isURL="1"
    isEmpirix="0" isUTA="1" />
   </SiteSet>
   </GetAccountPackageByMonitorClassResult>
  </GetAccountPackageByMonitorClassResponse>
 </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
<GetAccountPackageByMonitorClassResult> Top-level container for the XML response of this web service None <Status> <AccountInfoName> <MonitorSet> <SiteSet> <PopulationSet> <BackboneSet> <GeoSet>
<Status> The container for the information about the status of the operation <GetAccountPackageByMonitorClassResult> <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
<AccountInfo> The container for the account summary information <GetAccountPackageByMonitorClassResult> None
name The name of the account user    
title The title of the account user    
first The first name of the account user    
last The last name of the account user    
username The username of this user    
address1 The address of this user    
address2 Additional address information for this user    
city The city where the user resides    
state The state where the user resides    
zip The zip code for the location where the user resides    
email The user’s email address    
phone The user’s phone number    
fax The user’s fax number    
gmtoffset The GMT offset for the user’s location—The time zones are based on Greenwich Mean Time (GMT) with hours added or subtracted to reach a specific local time zone.    
timezone The user’s timezone    
<MonitorSet> The container for the monitor information <GetAccountPackageByMonitorClassResult> <Monitor>
<Monitor>      
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    
frequencyinmins 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    
<SiteSet> The container for all of the sites configured for the given monitor class <GetAccountPackageByMonitorClassResult> <Site>
<Site> The container for the configuration of the node <SiteSet>  
sid The unique ID for the site    
name The name of the site    
status The status of the site:
  • ACTIVE
  • INACTIVE
   
city The city where the site resides    
state The state where the site resides    
country The country where the site resides    
ip The site’s IP address    
backboneId The site’s Backbone ID    
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).
   
<PopulationSet> The container for all of the populations configured for a monitor class <GetAccountPackageByMonitorClassResult> <Population>
<Population>      
id The population ID    
name The name of the population    
created The date when the population was created    
modified The date the population was last modified    
<BackboneSet> The container for the Backbone configured for a monitor class <GetAccountPackageByMonitorClassResult> <Backbone>
<Backbone>      
id The unique ID of a Backbone node <BackboneSet>  
name The name of the Backbone    
<GeoSet> The container for all of the locations configured for a given monitor class <GetAccountPackageByMonitorClassResult> <Geo>
<Geo>      
id Location ID <GeoSet>  
name The name of the location    
tlev      
prec      
status ACTIVE or INACTIVE    
class City Country Region    

Other SOAP and HTTP examples

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