GetTestsSummary

This method is used to request abbreviated test summary data for all of the browser tests of an account. You can request either summaries of active tests or those of inactive tests.

Action

http://gpn.webservice.gomez.com/TestManagementWS_30/TestManagementService.asmx?op=GetTestsSummary

Style

Document

Input (literal)

This element defines the request content for the GetTestsSummaryRequest. It contains credentials and a filter that restricts the output to either ACTIVE or INACTIVE tests.

Element Type Occurs Nillable? Description
SEQUENCE 1..1
Credentials anyType (restriction) 1..1 No A Credentials element contains the username and password of an account user. The element is required in all requests to the Test Management Web Service.
UserName [element Credentials] string 1..1 No The UserName of an employee for an account (and used for authentication).
Password [element Credentials] string 1..1 No A secret used as part of user credentials for authentication. Every request to the Test Management API web service must include a Credentials element. That element itself contains a UserName and a Password element.
MonitorStatus [element GetTestsSummaryRequest] MonitorStatusType 1..1 No The MonitorStatus element filters out tests whose status is not equal to the value of this element sent by the API client.

Output (literal)

This element defines the format of the output of the GetTestsSummary method. The output will contain zero to many test summaries.

Element Type Occurs Nillable? Description
SEQUENCE 1..1
ResponseStatus ResponseStatusType 1..1 No This element appears in most of the responses that are issued when the Test Management API operations are invoked.
ErrorMessage [type OperationResponseType] string 0..1 No The error message is provided if the ResponseStatus was FAILURE.
MonitorSummaries anyType (restriction) 1..1 No Appears in a GetTestsSummaryResponse (the payload returned by the server on a GetTestsSummary operation invocation). Contains a MonitorSummary for each test returned by the query.

Example

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:prov="http://www.gomeznetworks.com/schemas/provisioning">
   <soapenv:Header/>
   <soapenv:Body>
      <prov:GetTestsSummaryRequest>
         <prov:Credentials>
            <prov:UserName>erics</prov:UserName>
            <prov:Password>erics</prov:Password>
         </prov:Credentials>
         <prov:MonitorStatus>Active</prov:MonitorStatus>
      </prov:GetTestsSummaryRequest>
   </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>
      <GetTestsSummaryResponse xmlns="http://www.gomeznetworks.com/schemas/provisioning">
         <ResponseStatus>SUCCESS</ResponseStatus>
         <MonitorSummaries>
            <MonitorSummary monitorId="263748" description="Site
               Management Test SingleStepMonitor 7/19/2012
               10:16:55 AM" status="Active" frequencyInMins="60"
               summaryFlag="Off" createDate="2012-07-19T14:16:54"
               modifyDate="2012-07-19T14:16:56" ipVersion="IPv4_only"/>
            <MonitorSummary monitorId="263749" description="Site
               Management Test SingleStepMonitor 7/19/2012 10:16:57
               AM" status="Active" frequencyInMins="60"
               summaryFlag="Off" createDate="2012-07-19T14:16:57"
               modifyDate="2012-07-19T14:16:59" ipVersion="IPv4_only"/>
         </MonitorSummaries>
      </GetTestsSummaryResponse>
   </soap:Body>
</soap:Envelope>