GetAccountMonitorBatchGroups

Use this method to retrieve a complete set of the monitor batch groups configured by group and status.

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/GetAccountMonitorBatchGroups?sUsername=string&sPassword=string&sStatusDesignator=string&sClassDesignator=string

After specifying the following parameters:

  • sUsername – The account username
  • sPassword – The account password
  • sStatusDesignator - Specify one of the following:
    • ALL
    • ACTIVE
    • INACTIVE
  • sClassDesignator - Specify one of the following:
    • ALL
    • STANDARD
    • NORMAL
    • LOADTEST

Validation criteria

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

  • sUsername is valid for an account.
  • sPassword is valid for the specified username.
  • sStatusDesignator is valid.
  • sClassDesignator is valid.

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>
    <GetAccountMonitorBatchGroupsResponse xmlns="http://gomeznetworks.com/webservices/">
     <GetAccountMonitorBatchGroupsResult>
      <Status>
       <eStatus>STATUS_FAILED</eStatus>
       <sErrorMessage>ERROR : Invalid class designator, it must be (ALL
         | STANDARD |   NORMAL | LOADTEST).</sErrorMessage>
      </Status>
    </GetAccountMonitorBatchGroupsResult>
   </GetAccountMonitorBatchGroupsResponse>
  </soap:Body>
</soap:Envelope>

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>
    <GetAccountMonitorBatchGroupsResponse xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountMonitorBatchGroupsResult>
        <Status>
          <eStatus>STATUS_SUCCESS</eStatus>
          <sErrorMessage>string</sErrorMessage>
        </Status>
        <AccountId>string</AccountId>
     <MonitorBatchGroupSet>
     <MonitorBatchGroup created="6/6/2013 7:58:54 AM"
      desc="w3c-1step-1page-www.google.com - FF Agent"
        end="6/8/2014 12:00:00 AM" frequencyinms="60" groupId="12481"
      modified="6/8/2013 9:16:15 AM"
        start="6/6/2013 7:58:54 AM" status="ACTIVE" />
     <MonitorBatchGroup created="6/6/2013 8:08:03 AM"
        desc="w3c-1page-3steps-www.ranknow.cn - FF Agent"
        end="6/8/2014 12:00:00 AM" frequencyinms="60" groupId="12482"
        modified="6/8/2013 9:16:15 AM"
        start="6/6/2013 8:08:03 AM" status="ACTIVE" />
     </MonitorBatchGroupSet>
    </GetAccountMonitorBatchGroupsResult>
   </GetAccountMonitorBatchGroupsResponse>
  </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
<GetAccountMonitorBatchGroupResult> Top-level container for the XML response of this web service None <Status> <MonitorBatchGroupSet>
<Status> The container for the information about the status of the operation <GetAccountMonitorBatchGroupResult> <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
<AccountId> The account ID <GetAccountMonitorBatchGroupResult> None
<MonitorBatchGroupSet> The container for the set of MBG groups configured for the account <GetAccountMonitorBatchGroupResult> <MonitorBatchGroup>
<MonitorBatchGroup> The information for an individual batch group <MonitorBatchGroupSet> None
created The time the group was created
desc The description of the group
end The end time of the group
frequencyinms The interval, in milliseconds, between the test runs
groupId The unique ID of the group
modified The time the group was last modified
start The start time of the group
status The status of the group:
  • ACTIVE
  • INACTIVE

Example

This web method allows users to get NumPeersRequested for Last Mile, Private Last Mile, or Mobile from GetAccountMonitorBatchGroups.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:web="http://gomeznetworks.com/webservices/">
    <soapenv:Header />
    <soapenv:Body>
        <web:GetAccountMonitorBatchGroups>
            <web:sUsername>gomez4tpeu</web:sUsername>
            <web:sPassword>gomez4tpeu</web:sPassword>
            <web:sStatusDesignator>active</web:sStatusDesignator>
            <web:sClassDesignator>standard</web:sClassDesignator>
        </web:GetAccountMonitorBatchGroups>
    </soapenv:Body>
</soapenv:Envelope> 

Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <GetAccountMonitorBatchGroupsResponse xmlns="http://gomeznetworks.com/webservices/">
            <GetAccountMonitorBatchGroupsResult>
                <Status>
                    <eStatus>STATUS_SUCCESS</eStatus>
                    <sErrorMessage />
                </Status>
                <AccountId>10</AccountId>
                <MonitorBatchGroupSet>
                    <MonitorBatchGroup created="10/13/2014 5:44:27 AM" desc="adobe - FF Agent" end="9/20/2015 12:00:00 AM"
                                       frequencyinms="60" groupId="15379" modified="11/24/2014 2:57:29 AM"
                                       start="10/13/2014 5:44:27 AM" status="ACTIVE">
                        <MbgPopulationSet>
                            <MbgPopulation MBG_ID="15379" Population_ID="258" NumPeersRequested="10" Status="ACTIVE" />
                            <MbgPopulation MBG_ID="15379" Population_ID="406" NumPeersRequested="10" Status="ACTIVE" />
                            <MbgPopulation MBG_ID="15379" Population_ID="718" NumPeersRequested="10" Status="ACTIVE" />
                            <MbgPopulation MBG_ID="15379" Population_ID="722" NumPeersRequested="10" Status="ACTIVE" />
                            <MbgPopulation MBG_ID="15379" Population_ID="727" NumPeersRequested="10" Status="ACTIVE" />
                            <MbgPopulation MBG_ID="15379" Population_ID="2204" NumPeersRequested="10" Status="ACTIVE" />
                        </MbgPopulationSet>
                    </MonitorBatchGroup>
                </MonitorBatchGroupSet>
            </GetAccountMonitorBatchGroupsResult>
        </GetAccountMonitorBatchGroupsResponse>
    </soap:Body>
</soap:Envelope> 

Other SOAP and HTTP examples

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