TestStatusUpdate

This method is used to update the status of an existing test.

Action

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

Style

Document

Input (literal)

This element contains a TestStatusUpdateRequest composed of user credentials and one to many test status update requests.

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.
TestStatusUpdate [element TestStatusUpdateRequest] anyType (restriction) 1..* No A TestStatusUpdate identifies a specific test in the system by its monitorId and sets the Status that the test has after the update has occurred.

Output (literal)

This element contains the response message for the TestStatusUpdateRequest. The response will indicate whether the TestStatusUpdate was successful and provide an error message in the case where the operation was unsuccessful.

Element Type Occurs Nillable? Description
SEQUENCE   1..1    
ResponseStatus ResponseStatusType 1..1 No This element appears in most of the responses 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.

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:TestStatusUpdateRequest>
         <prov:Credentials>
            <prov:UserName>erics</prov:UserName>
            <prov:Password>erics</prov:Password>
         </prov:Credentials>
         <prov:TestStatusUpdate monitorId="263717" status="Active"/>
      </prov:TestStatusUpdateRequest>
   </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>
      <TestStatusUpdateResponse
         xmlns="http://www.gomeznetworks.com/schemas/provisioning">
         <ResponseStatus>SUCCESS</ResponseStatus>
      </TestStatusUpdateResponse>
   </soap:Body>
</soap:Envelope>