GetAccountPopulations

Use this method to retrieve a complete set of the public populations, private populations or global populations for the specified 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:

To access the details about this method, access the following address in your browser:

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

After specifying the following parameters:

  • sUsername – The account username
  • sPassword – The account password
  • getDefinitions - The population definitions may optionally be retrieved by setting the getDefinitions flag to true or false.
  • populationType - Set the populationType to:
    • ALL
    • PUBLIC
    • PRIVATE
    • GLOBAL

Validation criteria

This web services uses the following criteria to validate the incoming request:

  • 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>
  <GetAccountPopulationsResponse
      xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountPopulationsResult>
        <Status>
         <eStatus>STATUS_FAILED</eStatus>
         <sErrorMessage>INVALID ACCOUNT</sErrorMessage>
        </Status>
      </GetAccountPopulationsResult>
    </GetAccountPopulationsResponse>
  </soap:Body>
</soap:Envelope>

STATUS_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>
  <GetAccountPopulationsResponse
      xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountPopulationsResult>
        <Status>
         <eStatus>STATUS_SUCCESS</eStatus>
         <sErrorMessage/>
       </Status>
    <PopulationSet>
     <Population id="89" name="U.S. - High Broadband" type="PUBLIC"/>
     <Population id="90" name="U.S. - Low Broadband" type="PUBLIC"/>
     <Population id="91" name="U.S. - Dial Up" type="PUBLIC"/>
     <Population id="413" name="Asia - High Broadband" type="PUBLIC"/>
     <Population id="938" name="TestPopulationwyj" type="PUBLIC"/>
     <Population id="940" name="TestPopulationwyj1" type="PUBLIC"/>
     <Population id="941" name="TestPopulationwyj2" type="PUBLIC"/>
     <Population id="996" name="new_porivoDB_corp" type="PUBLIC"/>
     <Population id="2149" name="Penang" type="PUBLIC"/>
     <Population id="2151" name="Sabah" type="PUBLIC"/>
    </PopulationSet>
      </GetAccountPopulationsResult>
    </GetAccountPopulationsResponse>
  </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
<GetAccountPopulationsResponse> Top-level container for the XML response of this web service None <Status> <PopulationSet>
<Status> The container for the information about the status of the operation <GetAccountPopulationsResponse> <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
<PopulationSet> The container for the population set <GetAccountPopulationsResponse> <Population>
<Population> The container for the population <PopulationSet> <PopulationDefinitions>
id The population ID    
name The population name    
<PopulationDefinition> The container for the population <PopulationDefinitions> None
populationdefinitionid The population definition ID    
keyword The name of the property    
value The value of the property    
isIncluded Indicates if the property (Keyword/Value) applies or will be removed from the definition set.    

Other SOAP and HTTP examples

http://gpn.webservice.gomez.com/GpnAccountManagementWS_20/AccountManagementWS.asmx?op=GetAccountPopulations