GetAccountSummary

Use this method to retrieve a summary information for your account.

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/GetAccountSummary?sUsername=string&sPassword=string

After specifying 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

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>
    <GetAccountSummaryResponse
       xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountSummaryResult>
        <Status>
  <eStatus>STATUS_FAILED</eStatus>
  <sErrorMessage>INVALID ACCOUNT</sErrorMessage>
  </Status>
    </GetAccountSummaryResult>
  </GetAccountSummaryResponse>
 </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>
   <GetAccountSummaryResponse
       xmlns="http://gomeznetworks.com/webservices/">
    <GetAccountSummaryResult>
        <Status>
         <eStatus>STATUS_SUCCESS</eStatus>
         <sErrorMessage />
        </Status>
    <AccountConstraints name="Jane Doe"
      title="Software Developer" first="Jane" last="Doe"
      username="jdoe" address1="One Campus Martius"
      address2="" city="Detroit" state="MI" zip="48226"
      email="janedoe@company.com" phone="(313) 555-1212"
      fax="" gmtoffset="240" timezone="
     (GMT 04:00) Eastern Daylight Savings Time" />
    </GetAccountSummaryResult>
  </GetAccountSummaryResponse>
 </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
<GetAccountSummaryResponse> Top-level container for the XML response of this web service None <Status> <AccountConstraints>
<Status> The container for the information about the status of the operation <GetAccountSummaryResponse> <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
<AccountConstraints> The container for the account summary information <GetAccountSummaryResponse> None.
name The name of the account
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 of the account
state The state of the account
zip The zip code for the account
email The email address
phone The phone number
fax The fax number
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 timezone of the account

Other SOAP and HTTP examples

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