ProvisionLastMileTests

This web method is used to provision one or more Last Mile Single Step browser tests. Each test defined in the request constitutes a monitor order. The response indicates the success or failure of each monitor order in the request. Each monitor order will be handled in its own transaction, and the service will process the monitor orders in sequence until all the monitor orders have been processed or one monitor order fails.

Action

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

Style

Document

Input (literal)

This message contains a single ProvisionLastMileTestsRequest element. The ProvisionLastMileTestsRequest element defines one or more SingleStep Last Mile browser tests. Each test definition constitutes a monitor order.

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.
SingleStepLastMileMonitors anyType (restriction) 0..1 No A SingleStepLastMileMonitors element appears in a ProvisionLastMileTestsRequest and is used to create one or more Last Mile tests that browse a single URL.

Output (literal)

This message contains a single ProvisionLastMileTestsResponse element defining one or more monitor order responses. The success or failure of each monitor order is shown. If a failure is encountered, the reason for the failure is shown under the monitor order that failed. However many monitor orders the request contained, there are never more than one failed monitor order in the response, because processing is halted the moment the failure occurs.

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.
LastMileMonitorOrderResponses anyType (restriction) 1..1 No LastMileMonitorOrderResponses are collections of LastMileMonitorOrderResponse elements. They occur in the responses of ProvisionLastMileTests operation invocations. See the LastMileMonitorOrderResponse help page for more information.

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:ProvisionLastMileTestsRequest>
            <prov:Credentials>
                <prov:UserName>gomez4tpeu</prov:UserName>
                <prov:Password>gomez4tpeu</prov:Password>
            </prov:Credentials>
            <prov:SingleStepLastMileMonitors>
                <prov:SingleStepLastMileMonitor Name="TEST???" Folder="" agentType="IE"
                        summaryFlag="Off" ExpirationDate="2015-01-30T00:00:00.000+08:00"
                        ipVersion="IPv6_preferred" Status="Active">
                    <prov:Populations>123</prov:Populations>
                    <prov:captureDNSServer>true</prov:captureDNSServer>
                    <prov:captureRequestResponseHeader>true</prov:captureRequestResponseHeader>
                    <prov:URL>www.gomez.com</prov:URL>
                </prov:SingleStepLastMileMonitor>
            </prov:SingleStepLastMileMonitors>
        </prov:ProvisionLastMileTestsRequest>
    </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>
        <ProvisionLastMileTestsResponse
               xmlns="http://www.gomeznetworks.com/schemas/provisioning">
            <ResponseStatus>FAILURE</ResponseStatus>
            <ErrorMessage>Name should not contain special characters!</ErrorMessage>
        </ProvisionLastMileTestsResponse>
    </soap:Body>
</soap:Envelope>