GetAccountPrivatePeers

Use this method to retrieve a complete set of the private peers created for the 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/GetAccountPrivatePeers?sUsername=string&sPassword=string

After specifying the following parameters:

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

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:

<?xml version="1.0" encoding="utf-8"?>
<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>
  <GetAccountPrivatePeersResponse
      xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountPrivatePeersResult
        <Status>
         <eStatus>STATUS_FAILED</eStatus>
         <sErrorMessage>INVALID ACCOUNT</sErrorMessage>
        </Status>
      </GetAccountPrivatePeersResult>
    </GetAccountPrivatePeersResponse>
  </soap:Body>
</soap:Envelope>

STATUS_SUCCESS

If the web service operation succeeds, the following requested information is returned in the following XML format:

<?xml version="1.0" encoding="utf-8"?>
<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>
  <GetAccountPrivatePeersResponse
      xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountPrivatePeersResult
        <Status>
         <eStatus>STATUS_SUCCESS</eStatus>
         <sErrorMessage/>
       </Status>
     <PrivatePeerSet>
      <PrivatePeer machine_id="35395" name="BILL" memory="383"
       location="unset" usr_id="50641" lastused="1/1/0001 12:00:00 AM"
       zipcode="" network="T1" cpu="Pentium II" OS="Windows XP"
       first_heartbeat_date="8/10/2004 11:03:00 AM" isp="Cable & Wireless"
       last_heartbeat_date="8/5/2013 6:45:22 AM" ip="208.159.60.250"
       country="United States" region="Massachusetts" onlineTime="00:00:00"
       processingTime="00:00:00" user_def1="" user_def2="" user_def3=""/>
       <PrivatePeer machine_id="35406" name="SHUTCHINSON" memory="255"
       location="unset" usr_id="50641" lastused="9/5/2004 6:52:16 PM"
       zipcode="02451" network="High Broadband" cpu="Pentium II"
       OS="Windows NT" first_heartbeat_date="9/1/2004 3:20:00 AM"
       isp="undefined" last_heartbeat_date="8/5/2013 6:45:22 AM"
       ip="0.152.193.245" country="United States" region="Massachusetts"
       onlineTime="00:00:00" processingTime="00:00:00" user_def1="QA"
       user_def2="610 Lincoln Street" user_def3="in office"/>
      <PrivatePeer machine_id="35408" name="SBRINDAMOUR"
       memory="383" location="unset" usr_id="50641"
       lastused="1/1/0001 12:00:00 AM" zipcode="" network="T1"
       cpu="Pentium II" OS="Windows XP" first_heartbeat_date="12/8/2004
       5:07:00 AM" isp="Cable & Wireless" last_heartbeat_date="8/5/2013
       6:45:22 AM" ip="208.159.60.250" country="United States"
       region="Massachusetts" onlineTime="00:00:00"
       processingTime="00:00:00" user_def1="" user_def2="" user_def3=""/>
     </PrivatePeerSet>
    </GetAccountPrivatePeersResult>
   </GetAccountPrivatePeersResponse>
  </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
<GetAccountPrivatePeersResult> Top-level container for the XML response of this web service None <Status> <PrivatePeerSet>
<Status> The container for the information about the status of the operation <GetAccountPrivatePeersResult> <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
<PrivatePeerSet> The container for the private peer <GetAccountPrivatePeersResult> None
<PrivatePeer> The container for the private peers set <PrivatePeerSet> None
machine_id The private peer machine ID
name The private peer name
memory The private peer memory
location The private peer's location
zipcode The private peer's zip code
cpu The private peer's CPU

Other SOAP and HTTP examples

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