GetAccountConfigPackage

Use this method to retrieve a complete account configuration information that includes all of the data returned by all of the other methods return.

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 after specifying the parameters listed below.

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

Specify the following parameters:

  • sUsername – The account username
  • sPassword – The account password

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>
  <GetAccountConfigPackageResponse
      xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountConfigPackageResult>
        <Status>
           <eStatus>STATUS_FAILED</eStatus>
           <sErrorMessage>INVALID ACCOUNT</sErrorMessage>
        </Status>
    </GetAccountConfigPackageResult>
   </GetAccountConfigPackageResponse>
  </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>
  <GetAccountConfigPackageResponse
      xmlns="http://gomeznetworks.com/webservices/">
   <GetAccountConfigPackageResult>
     <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="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="6/10/2008 7:20:48 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>
 <BackboneSet>
     <Backbone id="2" name="Sprint" />
     <Backbone id="3" name="Cable & Wireless" />
  …
  </BackboneSet>
 <GeoSet>
   <Geo id="102" name="Argentina" tlev="3"
       prec="34020000" status="Active" class="Country">
       <GeoSite>303</GeoSite>
  </Geo>
  <Geo id="103" name="Buenos Aires" tlev="5"
      prec="34020001" status="Active" class="City">
     <GeoSite>303</GeoSite>
  </Geo>
  <Geo id="1" name="USA" tlev="1" prec="20000000"
       status="Active" class="Country">
       <GeoSite>101</GeoSite>
       <GeoSite>102</GeoSite>
       <GeoSite>105</GeoSite>
       <GeoSite>109</GeoSite>
       <GeoSite>110</GeoSite>
  …
   </Geo>
  </GeoSet>
   </GetAccountConfigPackageResult>
  </GetAccountConfigPackageResponse>
 </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
<GetAccountConfigPackageResponse> Top-level container for the XML response of this web service. None <Status> <AccountInfo> <MonitorSet> <SiteSet> <GeoSet>
<Status> The container for the information about the status of the operation <GetAccountConfigPackageResponse> <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 information about an account <GetAccountConfigPackageResponse> None
name The full name of the account user
title The job title of the account user
first The first name of the account user
last The last name of the account user
username The login name of the account user
address1 The first address line of the account
address2 The second address line of the account
city The city of the account
state The state of the account
zip The zip code of the account
email The email address of the account
phone The phone number of the account
fax The fax number of the account
gmtoffset The GMT offset for the account'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 account's time zone
<MonitorSet> The container for the account monitor information <GetAccountConfigPackageResponse> <Monitor>
<Monitor> The container for the configuration of a single monitor <Monitor> 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
<SiteSet> The container for the account site information <GetAccountConfigPackageResponse> <Site>
<Site> The container for the information for a single 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 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
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
Set the value to 0 (NO).
Backbone The container for the information about a single Backbone
id The unique ID of a Backbone node
name The name of the Backbone
<GeoSet> Container for the related geographical information <GetAccountConfigPackageResponse> <Geo>
<Geo>
id Location ID <GeoSet> None
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/GpnAccountManagementWS_20/AccountManagementWS.asmx?op=GetAccountConfigPackage