Prepare SOAP Requests in Scripts

Web services use the SOAP protocol to transmit data in the XML format to web service methods and to return the results to the caller.

According to the SOAP protocol, XML data transmitted to a web service as a request contains a root Envelope element that includes:

• The required Body element (the SOAP body part). Method parameters are transferred in the request’s SOAP body.

• An optional Header element (the SOAP header part). SOAP headers can contain some additional information transmitted to the web service. For instance, SOAP headers may be used for passing authentication credentials to the web service.

For more information on the format of SOAP requests, see the Understanding SOAP article in the MSDN Library.

In TestComplete, to create a custom SOAP request, you can use the WebServiceInfo.PrepareRequestObject method. Use the object the method returns to specify the parameters to be passed to your tested web service. Then use the WebServiceInfo.PrepareRequest method to create an XML document with the specified parameters in the SOAP body. This way, you do not need to manually create and edit the XML data to be sent to your server.

Note: However, the generated SOAP request will not contain any headers. To add a header to your request, you will have to create the appropriate XML elements and add them to the request manually.

The instructions below explain how to create a custom SOAP request, add headers to it, and then send the request to the tested web service:

1. If your TestComplete project does not have the WebServices collection, add it. See Creating Web Service Tests.

   

   Click the image to enlarge it.

2. (Optional.) Add your tested web service to the WebServices collection. See Creating Web Service Tests.

   

   Click the image to enlarge it.

3. In your script, create a WebServiceInfo object that will provide access to your tested web service methods and data types.

   If your tested web service is added to your project’s WebServices collection, use the WebServices.CreateWebServiceInfoFromItem method:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let serviceInfo = WebServices.CreateWebServiceInfoFromItem("SampleWebService");

   JScript

   var serviceInfo = WebServices.CreateWebServiceInfoFromItem("SampleWebService");

   Python

   serviceInfo = WebServices.CreateWebServiceInfoFromItem("SampleWebService")

   VBScript

   Set serviceInfo = WebServices.CreateWebServiceInfoFromItem("SampleWebService")

   DelphiScript

   var serviceInfo;
   …
   serviceInfo := WebServices.CreateWebServiceInfoFromItem('SampleWebService');

   C#Script

   var serviceInfo = WebServices["CreateWebServiceInfoFromItem"]("SampleWebService");

   Otherwise, use the WebServices.CreateWebServiceInfo method:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let URL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL";
   let serviceName = "SampleWebService";
   let soapVersion = WebServices.svSoap11;
   
   let serviceInfo = WebServices.CreateWebServiceInfo(URL, serviceName, soapVersion);

   JScript

   var URL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL";
   var serviceName = "SampleWebService";
   var soapVersion = WebServices.svSoap11;
   
   var serviceInfo = WebServices.CreateWebServiceInfo(URL, serviceName, soapVersion);

   Python

   URL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL"
   serviceName = "SampleWebService"
   soapVersion = WebServices.svSoap11
   
   serviceInfo = WebServices.CreateWebServiceInfo(URL, serviceName, soapVersion)

   VBScript

   URL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL"
   serviceName = "SampleWebService"
   soapVersion = WebServices.svSoap11
   
   Set serviceInfo = WebServices.CreateWebServiceInfo(URL, serviceName, soapVersion)

   DelphiScript

   var URL, serviceName, soapVersion, serviceInfo;
   …
   URL := 'http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL';
   serviceName := 'SampleWebService';
   soapVersion := WebServices.svSoap11;
   
   serviceInfo := WebServices.CreateWebServiceInfo(URL, serviceName, soapVersion);

   C#Script

   var URL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL";
   var serviceName = "SampleWebService";
   var soapVersion = WebServices["svSoap11"];
   
   var serviceInfo = WebServices["CreateWebServiceInfo"](URL, serviceName, soapVersion);

4. Use the WebServiceInfo.PrepareRequestObject to create a helper object that will store the parameters to be passed to a web service method:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let methodName = "SetSampleObject";
   let requestObj = serviceInfo.PrepareRequestObject(methodName);

   JScript

   var methodName = "SetSampleObject";
   var requestObj = serviceInfo.PrepareRequestObject(methodName);

   Python

   methodName = "SetSampleObject"
   requestObj = serviceInfo.PrepareRequestObject(methodName)

   VBScript

   methodName = "SetSampleObject"
   Set requestObj = serviceInfo.PrepareRequestObject(methodName)

   DelphiScript

   var methodName, requestObj;
   …
   methodName := 'SetSampleObject';
   requestObj := serviceInfo.PrepareRequestObject(methodName);

   C#Script

   var methodName = "SetSampleObject";
   var requestObj = serviceInfo["PrepareRequestObject"](methodName);

5. The properties of the created helper object correspond to the tested web service method’s parameters. Assign the values you want to pass to your tested web service method to the object properties:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   // The method takes the obj parameter that is an object of the SampleTestClass
   requestObj.obj = serviceInfo.TypeFactory.SampleTestClass;
   …

   JScript

   // The method takes the obj parameter that is an object of the SampleTestClass
   requestObj.obj = serviceInfo.TypeFactory.SampleTestClass;
   …

   Python

   # The method takes the obj parameter that is an object of the SampleTestClass
   requestObj.obj = serviceInfo.TypeFactory.SampleTestClass
   …

   VBScript

   ' The method takes the obj parameter that is an object of the SampleTestClass
   Set requestObj.obj = serviceInfo.TypeFactory.SampleTestClass
   …

   DelphiScript

   // The method takes the obj parameter that is an object of the SampleTestClass
   requestObj.obj := serviceInfo.TypeFactory.SampleTestClass;
   …

   C#Script

   // The method takes the obj parameter that is an object of the SampleTestClass
   requestObj["obj"] = serviceInfo["TypeFactory"]["SampleTestClass"];
   …

6. Use the WebServiceInfo.PrepareRequest method to generate an XML document from the helper object:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let requestXml = serviceInfo.PrepareRequest(methodName, requestObj);

   JScript

   var requestXml = serviceInfo.PrepareRequest(methodName, requestObj);

   Python

   requestXml = serviceInfo.PrepareRequest(methodName, requestObj)

   VBScript

   Set requestXml = serviceInfo.PrepareRequest(methodName, requestObj)

   DelphiScript

   var requestXml;
   …
   requestXml := serviceInfo.PrepareRequest(methodName, requestObj);

   C#Script

   var requestXml = serviceInfo["PrepareRequest"](methodName, requestObj);

   The generated XML document contains a SOAP body with the specified method parameters to be passed to the tested web service:

   XML

   Copy Code

   XML

   <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
     <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xmlns:ns1="http://smartbear.com">
       <ns1:SetSampleObject>
         <ns1:obj xsi:type="ns1:SampleTestClass">
           …
         </ns1:obj>
       </ns1:SetSampleObject>
     </s:Body>
   </s:Envelope>

   If needed, you can use properties and methods of the IXMLDOMDocument interface to modify the content of the created XML document. To learn more, see the description of the IXMLDOMDocument interface in the MSDN Library.

   For example, you may need this to add a Header to your SOAP request:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let root = requestXml.documentElement;
   let headerElement = requestXml.createElement("s:Header");
   let headerNode = root.insertBefore(headerElement, root.childNodes.item(0));

   JScript

   var root = requestXml.documentElement;
   var headerElement = requestXml.createElement("s:Header");
   var headerNode = root.insertBefore(headerElement, root.childNodes.item(0));

   Python

   root = requestXml.documentElement
   headerElement = requestXml.createElement("s:Header")
   headerNode = root.insertBefore(headerElement, root.childNodes.item[0])

   VBScript

   Set root = requestXml.documentElement
   Set headerElement = requestXml.createElement("s:Header")
   Set headerNode = root.insertBefore(headerElement, root.childNodes.item(0))

   DelphiScript

   var root, headerElement, headerNode;
   …
   root := requestXml.documentElement;
   headerElement := requestXml.createElement('s:Header');
   headerNode := root.insertBefore(headerElement, root.childNodes.item(0));

   C#Script

   var root = requestXml["documentElement"];
   var headerElement = requestXml["createElement"]("s:Header");
   var headerNode = root["insertBefore"](headerElement, root["childNodes"]["item"](0));

   Note: If your tested web service does not require that SOAP requests contain headers, you do not need to add them.

7. Create an XMLHTTP object:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let xmlHttpRequest = getActiveXObject("MSXML2.XMLHTTP.3.0");

   JScript

   var xmlHttpRequest = new ActiveXObject("MSXML2.XMLHTTP.3.0");

   Python

   xmlHttpRequest = Sys.OleObject["MSXML2.XMLHTTP.3.0"]

   VBScript

   Set xmlHttpRequest = CreateObject("MSXML2.XMLHTTP.3.0")

   DelphiScript

   var xmlHttpRequest;
   …
   xmlHttpRequest := Sys.OleObject('MSXML2.XMLHTTP.3.0');

   C#Script

   xmlHttpRequest = new ActiveXObject("MSXML2.XMLHTTP.3.0");

   The object allows sending XML data to HTTP servers and receiving server responses.

8. Use the open and send methods of the created XMLHTTP object to send the created SOAP request to the tested web service:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx";
   xmlHttpRequest.open("POST", serviceURL, false);
   xmlHttpRequest.send(requestXml);

   JScript

   var serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx";
   xmlHttpRequest.open("POST", serviceURL, false);
   xmlHttpRequest.send(requestXml);

   Python

   serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx"
   xmlHttpRequest.open("POST", serviceURL, False)
   xmlHttpRequest.send(requestXml)

   VBScript

   serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx"
   Call xmlHttpRequest.open("POST", serviceURL, False)
   xmlHttpRequest.send(requestXml)

   DelphiScript

   var serviceURL;
   …
   serviceURL := 'http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx';
   xmlHttpRequest.open('POST', serviceURL, false);
   xmlHttpRequest.send(requestXml);

   C#Script

   var serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx";
   xmlHttpRequest["open"]("POST", serviceURL, false);
   xmlHttpRequest["send"](requestXml);

9. (Optional.) To get the server response in your script, use the responseXML property of the XMLHTTP object:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let responseXML = xmlHttpRequest.responseXML;

   JScript

   var responseXML = xmlHttpRequest.responseXML;

   Python

   responseXML = xmlHttpRequest.responseXML

   VBScript

   Set responseXML = xmlHttpRequest.responseXML

   DelphiScript

   var responseXML;
   …
   responseXML := xmlHttpRequest.responseXML;

   C#Script

   var responseXML = xmlHttpRequest["responseXML"];

   It returns the response body as an XML document.

   You can use the WebServiceInfo.ParseResponse method to process the response and get the object whose properties contain the output parameters of a method of the web service:

   JavaScript

   JScript

   Python

   VBScript

   DelphiScript

   C#Script

   Copy Code

   JavaScript

   let response = serviceInfo.ParseResponse(methodName, responseXML);
   Log.Message("Result Value: " + response.SetSampleObjectResult);

   JScript

   var response = serviceInfo.ParseResponse(methodName, responseXML);
   Log.Message("Result Value: " + response.SetSampleObjectResult);

   Python

   response = serviceInfo.ParseResponse(methodName, responseXML)
   Log.Message("Result Value: " + response.SetSampleObjectResult)

   VBScript

   Set response = serviceInfo.ParseResponse(methodName, responseXML)
   Call Log.Message("Result Value: " & response.SetSampleObjectResult)

   DelphiScript

   var response;
   …
   response := serviceInfo.ParseResponse(methodName, responseXML);
   Log.Message('Result Value: ' + response.SetSampleObjectResult);

   C#Script

   var response = serviceInfo["ParseResponse"](methodName, responseXML);
   Log["Message"]("Result Value: " + response["SetSampleObjectResult"]);

You can view the whole sample code that shows how to prepare and send SOAP requests below.

If your tested web service uses the WCF technology and requires complex authentication, you cannot create a proper request header from scripts directly. As a workaround, you can do the following:

1. Add your tested web service to the WebServices collection in your project.

2. Add the Events collection to your TestComplete project:

   

   Click the image to enlarge it.

3. Add an Event Control item to the collection and then add a handler for the OnWebServiceRequest event:

   

   Click the image to enlarge it.

   TestComplete will call the handler whenever your test sends a request to the tested web service.

4. The event handler provides access to the content of the SOAP request to be sent and to the method of the tested web service to which the request is being sent. In the event handler, you can:

   • Add a custom SOAP header to the request. See Adding Custom Headers to SOAP Requests.

   • Set up authentication using the WebServices.Your_WebService_Item_Name.Credentials property.

   • Use the Request parameter of the handler to get the request contents and then modify it as needed by using the IXMLDOMDocument interface. See above.

5. Send a request to your tested web service using the appropriate method of the WebServices.Your_WebService_Item_Name object.

   Before sending a request, TestComplete will raise the OnWebServiceRequest event handler and process your request.

The code below shows how you can prepare SOAP requests and send them to your tested web service from scripts.

The code sends a SOAP request to the SetSampleObject method of the tested SampleWebService web service. The method takes the obj input parameter that is an object of the SampleTestClass class. The object has the following properties:

• X - Integer.

• Y - Integer.

• Name - String.

• IntArray - Array of integers.

In addition, the code adds authentication credentials to the request’s header: the Credentials element with the UserID and Password child elements. The code shows how to add such a header to the request using the IXMLDOMDocument interface.

Example

ExampleExample

JavaScript

JScript

Python

VBScript

DelphiScript

C++Script, C#Script

Copy Code

JavaScript

function WebServiceMethodTest()
{
  // Specify the web service location and the service's WSDL location
  let serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx";
  let wsdlURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL";

  // Specify the service name (as it is specified in its WSDL)
  let serviceName = "SampleWebService";

  // Specify the name of the web service method to be tested
  let methodName = "SetSampleObject";

  // Create a WebServiceInfo object
  let serviceInfo = WebServices.CreateWebServiceInfo(wsdlURL, serviceName, WebServices.svSoap11);

  // Create an object with the method's input parameters
  let requestObj = serviceInfo.PrepareRequestObject(methodName);

  // Specify the obj method parameter
  // The obj parameter takes an object of the SampleTestClass class
  requestObj.obj = serviceInfo.TypeFactory.SampleTestClass;
  requestObj.obj.Name = "Sample Object";
  requestObj.obj.X = 5;
  requestObj.obj.Y = 2.5;
  // Create an array of 5 elements for the obj.IntArray parameter
  let arrayObj = serviceInfo.TypeFactory.ArrayOfInt;
  // Initialize the array
  let a = new Array(4);
  for (let i = 0; i < 5; i++)
  {
    a[i] = i;
  }
  arrayObj.int = ConvertArray(a);
  requestObj.obj.IntArray = arrayObj;

  // Make an XML document for the SOAP request
  let requestXml = serviceInfo.PrepareRequest(methodName, requestObj);

  // Modify the XML data and add a SOAP header with credentials
  let root = requestXml.documentElement;

  // Create a Header element and insert it into the request
  let headerElement = requestXml.createElement("s:Header");
  let headerNode = root.insertBefore(headerElement, root.childNodes.item(0));

  // Create a Credentials element and insert it into the header
  let credentialsElement = requestXml.createNode(1, "Credentials", "http://smartbear.com");
  let credentialsNode = headerNode.appendChild(credentialsElement);

  // Create a UserID element within the Credentials element
  // and specify the user identifier
  let userIDElement = requestXml.createNode(1, "UserID", "http://smartbear.com");
  let userIDNode = credentialsNode.appendChild(userIDElement);
  let userIDValue = requestXml.createTextNode("jsmith");
  userIDNode.appendChild(userIDValue);

  // Create a Password element within the Credentials element
  // and specify the password
  let passwordElement = requestXml.createNode(1, "Password", "http://smartbear.com");
  let passwordNode = credentialsNode.appendChild(passwordElement);
  let passwordValue = requestXml.createTextNode("1234");
  passwordNode.appendChild(passwordValue);

  // Create an XMLHTTP object for sending the SOAP request
  xmlHttpRequest = getActiveXObject("MSXML2.XMLHTTP.3.0");

  // Send the created SOAP request to the web service
  xmlHttpRequest.open("POST", serviceURL, false);
  xmlHttpRequest.send(requestXml);

  // Get the service response
  let responseXML = xmlHttpRequest.responseXML;
  // Parse the response and post it to the test log
  let response = serviceInfo.ParseResponse(methodName, responseXML);
  Log.Message("Response value: " + response.SetSampleObjectResult);

}

// A helper routine that converts a native JavaScript array to a variant array
function ConvertArray(Array)
{
  // Uses the Dictionary object to convert an array
  var objDict = getActiveXObject("Scripting.Dictionary");
  objDict.RemoveAll();
  for (i in Array)
    objDict.Add(i, Array[i]);
  return objDict.Items();
}

JScript

function WebServiceMethodTest()
{
  // Specify the web service location and the service's WSDL location
  var serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx";
  var wsdlURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL";

  // Specify the service name (as it is specified in its WSDL)
  var serviceName = "SampleWebService";

  // Specify the name of the web service method to be tested
  var methodName = "SetSampleObject";

  // Create a WebServiceInfo object
  var serviceInfo = WebServices.CreateWebServiceInfo(wsdlURL, serviceName, WebServices.svSoap11);

  // Create an object with the method's input parameters
  var requestObj = serviceInfo.PrepareRequestObject(methodName);

  // Specify the obj method parameter
  // The obj parameter takes an object of the SampleTestClass class
  requestObj.obj = serviceInfo.TypeFactory.SampleTestClass;
  requestObj.obj.Name = "Sample Object";
  requestObj.obj.X = 5;
  requestObj.obj.Y = 2.5;
  // Create an array of 5 elements for the obj.IntArray parameter
  var arrayObj = serviceInfo.TypeFactory.ArrayOfInt;
  arrayObj.int = BuiltIn.CreateVariantArray(0, 4);
  // Initialize the array
  for (var i = 0; i < 5; i++)
  {
    arrayObj.int(i) = i;
  }
  requestObj.obj.IntArray = arrayObj;

  // Make an XML document for the SOAP request
  var requestXml = serviceInfo.PrepareRequest(methodName, requestObj);

  // Modify the XML data and add a SOAP header with credentials
  var root = requestXml.documentElement;

  // Create a Header element and insert it into the request
  var headerElement = requestXml.createElement("s:Header");
  var headerNode = root.insertBefore(headerElement, root.childNodes.item(0));

  // Create a Credentials element and insert it into the header
  var credentialsElement = requestXml.createNode(1, "Credentials", "http://smartbear.com");
  var credentialsNode = headerNode.appendChild(credentialsElement);

  // Create a UserID element within the Credentials element
  // and specify the user identifier
  var userIDElement = requestXml.createNode(1, "UserID", "http://smartbear.com");
  var userIDNode = credentialsNode.appendChild(userIDElement);
  var userIDValue = requestXml.createTextNode("jsmith");
  userIDNode.appendChild(userIDValue);

  // Create a Password element within the Credentials element
  // and specify the password
  var passwordElement = requestXml.createNode(1, "Password", "http://smartbear.com");
  var passwordNode = credentialsNode.appendChild(passwordElement);
  var passwordValue = requestXml.createTextNode("1234");
  passwordNode.appendChild(passwordValue);

  // Create an XMLHTTP object for sending the SOAP request
  xmlHttpRequest = new ActiveXObject("MSXML2.XMLHTTP.3.0");

  // Send the created SOAP request to the web service
  xmlHttpRequest.open("POST", serviceURL, false);
  xmlHttpRequest.send(requestXml);

  // Get the service response
  var responseXML = xmlHttpRequest.responseXML;
  // Parse the response and post it to the test log
  var response = serviceInfo.ParseResponse(methodName, responseXML);
  Log.Message("Response value: " + response.SetSampleObjectResult);

}

Python

def WebServiceMethodTest():
   # Specify the web service location and service's WSDL location
   serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete14/webservices/Service.asmx"
   wsdlURL = "http://secure.smartbearsoftware.com/samples/testcomplete14/webservices/Service.asmx?WSDL"

   # Specify the service name (as it is specified in its WSDL)
   serviceName = "SampleWebService"

   # Specify the name of the web service method to be tested
   methodName = "SetSampleObject"

   # Create a WebServiceInfo object
   serviceInfo = WebServices.CreateWebServiceInfo(wsdlURL, serviceName, WebServices.svSoap11)

   # Create an object with the method's input parameters
   requestObj = serviceInfo.PrepareRequestObject(methodName)

   # Specify the obj method parameter
   # The obj parameter takes an object of the SampleTestClass class
   requestObj.obj = serviceInfo.TypeFactory.SampleTestClass
   requestObj.obj.Name = "Sample Object"
   requestObj.obj.X = 5
   requestObj.obj.Y = 2.5
   # Create an array for the obj.IntArray parameter
   requestObj.obj.IntArray = serviceInfo.TypeFactory.ArrayOfInt
   # Initialize the array
   arrayObj = [0, 1, 2, 3, 4]
   requestObj.obj.IntArray.int = arrayObj
   
   # Make an XML document for the SOAP request
   requestXml = serviceInfo.PrepareRequest(methodName, requestObj)

   # Modify the XML data and add a SOAP header with credentials
   root = requestXml.documentElement

   # Create a Header element and insert it into the request
   headerElement = requestXml.createElement("s:Header")
   headerNode = root.insertBefore(headerElement, root.childNodes.item[0])

   # Create a Credentials element and insert it into the header
   credentialsElement = requestXml.createNode(1, "Credentials", "http://smartbear.com")
   credentialsNode = headerNode.appendChild(credentialsElement)

   # Create a UserID element within the Credentials element
   # and specify the user identifier
   userIDElement = requestXml.createNode(1, "UserID", "http://smartbear.com")
   userIDNode = credentialsNode.appendChild(userIDElement)
   userIDValue = requestXml.createTextNode("jsmith")
   userIDNode.appendChild(userIDValue)

   # Create a Password element within the Credentials element
   # and specify the password
   passwordElement = requestXml.createNode(1, "Password", "http://smartbear.com")
   passwordNode = credentialsNode.appendChild(passwordElement)
   passwordValue = requestXml.createTextNode("1234")
   passwordNode.appendChild(passwordValue)

   # Create an XMLHTTP object for sending the SOAP request
   xmlHttpRequest = Sys.OleObject["MSXML2.XMLHTTP.3.0"]

   # Send the created SOAP request to the web service
   xmlHttpRequest.open("POST", serviceURL, False)
   xmlHttpRequest.send(requestXml)

   # Get the service response
   responseXML = xmlHttpRequest.responseXML
   # Parse the response and post it to the test log
   response = serviceInfo.ParseResponse(methodName, responseXML)
   Log.Message("Response value: " + response.SetSampleObjectResult)

VBScript

Sub WebServiceMethodTest()
  ' Specify the web service location and the service's WSDL location
  serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx"
  wsdlURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL"

  ' Specify the service name (as it is specified in its WSDL)
  serviceName = "SampleWebService"

  ' Specify the name of the web service method to be tested
  methodName = "SetSampleObject"

  ' Create a WebServiceInfo object
  Set serviceInfo = WebServices.CreateWebServiceInfo(wsdlURL, serviceName, WebServices.svSoap11)

  ' Create an object with the method's input parameters
  Set requestObj = serviceInfo.PrepareRequestObject(methodName)

  ' Specify the obj method parameter
  ' The obj parameter takes an object of the SampleTestClass class
  requestObj.obj = serviceInfo.TypeFactory.SampleTestClass
  requestObj.obj.Name = "Sample Object"
  requestObj.obj.X = 5
  requestObj.obj.Y = 2.5
  ' Create an array of 5 elements for the obj.IntArray parameter
  Set arrayObj = serviceInfo.TypeFactory.ArrayOfInt
  arrayObj.int = BuiltIn.CreateVariantArray(0, 4)
  ' Initialize the array
  For i = 0 To 4
    arrayObj.int(i) = i
  Next
  requestObj.obj.IntArray = arrayObj

  ' Make an XML document for the SOAP request
  Set requestXml = serviceInfo.PrepareRequest(methodName, requestObj)

  ' Modify the XML data and add a SOAP header with credentials
  Set root = requestXml.documentElement

  ' Create a Header element and insert it into the request
  Set headerElement = requestXml.createElement("s:Header")
  Set headerNode = root.insertBefore(headerElement, root.childNodes.item(0))

  ' Create a Credentials element and insert it into the header
  Set credentialsElement = requestXml.createNode(1, "Credentials", "http://smartbear.com")
  Set credentialsNode = headerNode.appendChild(credentialsElement)

  ' Create a UserID element within the Credentials element
  ' and specify the user identifier
  Set userIDElement = requestXml.createNode(1, "UserID", "http://smartbear.com")
  Set userIDNode = credentialsNode.appendChild(userIDElement)
  Set userIDValue = requestXml.createTextNode("jsmith")
  userIDNode.appendChild(userIDValue)

  ' Create a Password element within the Credentials element
  ' and specify the password
  Set passwordElement = requestXml.createNode(1, "Password", "http://smartbear.com")
  Set passwordNode = credentialsNode.appendChild(passwordElement)
  Set passwordValue = requestXml.createTextNode("1234")
  passwordNode.appendChild(passwordValue)

  ' Create an XMLHTTP object for sending the SOAP request
  Set xmlHttpRequest = CreateObject("MSXML2.XMLHTTP.3.0")

  ' Send the created SOAP request to the web service
  Call xmlHttpRequest.open("POST", serviceURL, False)
  xmlHttpRequest.send(requestXml)

  ' Get the service response
  Set responseXML = xmlHttpRequest.responseXML
  ' Parse the response and post it to the test log
  Set response = serviceInfo.ParseResponse(methodName, responseXML)
  Log.Message("Response value: " & response.SetSampleObjectResult)

End Sub

DelphiScript

procedure WebServiceMethodTest();
var serviceURL, wsdlURL, serviceName, methodName;
var serviceInfo, requestObj, arrayObj, i;
var requestXml, root, headerElement, headerNode;
var credentialsElement, credentialsNode, userIDElement, userIDNode, userIDValue, passwordElement, passwordNode, passwordValue;
var xmlHttpRequest, responseXML, response;
begin
  // Specify the web service location and the service's WSDL location
  serviceURL := 'http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx';
  wsdlURL := 'http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL';

  // Specify the service name (as it is specified in its WSDL)
  serviceName := 'SampleWebService';

  // Specify the name of the web service method to be tested
  methodName := 'SetSampleObject';

  // Create a WebServiceInfo object
  serviceInfo := WebServices.CreateWebServiceInfo(wsdlURL, serviceName, WebServices.svSoap11);

  // Create an object with the method's input parameters
  requestObj := serviceInfo.PrepareRequestObject(methodName);

  // Specify the obj method parameter
  // The obj parameter takes an object of the SampleTestClass class
  requestObj.obj := serviceInfo.TypeFactory.SampleTestClass;
  requestObj.obj.Name := 'Sample Object';
  requestObj.obj.X := 5;
  requestObj.obj.Y := 2.5;
  // Create an array of 5 elements for the obj.IntArray parameter
  arrayObj := serviceInfo.TypeFactory.ArrayOfInt;
  arrayObj.int := BuiltIn.CreateVariantArray(0, 4);
  // Initialize the array
  for i := 0 to 4 do
    arrayObj.int(i) := i;
  requestObj.obj.IntArray := arrayObj;

  // Make an XML document for the SOAP request
  requestXml := serviceInfo.PrepareRequest(methodName, requestObj);

  // Modify the XML data and add a SOAP header with credentials
  root := requestXml.documentElement;

  // Create a Header element and insert it into the request
  headerElement := requestXml.createElement('s:Header');
  headerNode := root.insertBefore(headerElement, root.childNodes.item(0));

  // Create a Credentials element and insert it into the header
  credentialsElement := requestXml.createNode(1, 'Credentials', 'http://smartbear.com');
  credentialsNode := headerNode.appendChild(credentialsElement);

  // Create a UserID element within the Credentials element
  // and specify the user identifier
  userIDElement := requestXml.createNode(1, 'UserID', 'http://smartbear.com');
  userIDNode := credentialsNode.appendChild(userIDElement);
  userIDValue := requestXml.createTextNode('jsmith');
  userIDNode.appendChild(userIDValue);

  // Create a Password element within the Credentials element
  // and specify the password
  passwordElement := requestXml.createNode(1, 'Password', 'http://smartbear.com');
  passwordNode := credentialsNode.appendChild(passwordElement);
  passwordValue := requestXml.createTextNode('1234');
  passwordNode.appendChild(passwordValue);

  // Create an XMLHTTP object for sending the SOAP request
  xmlHttpRequest := Sys.OleObject('MSXML2.XMLHTTP.3.0');

  // Send the created SOAP request to the web service
  xmlHttpRequest.open('POST', serviceURL, false);
  xmlHttpRequest.send(requestXml);

  // Get the service response
  responseXML := xmlHttpRequest.responseXML;
  // Parse the response and post it to the test log
  response := serviceInfo.ParseResponse(methodName, responseXML);
  Log.Message('Response value: ' + response.SetSampleObjectResult);

end;

C++Script, C#Script

function WebServiceMethodTest()
{
  // Specify the web service location and the service's WSDL location
  var serviceURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx";
  var wsdlURL = "http://secure.smartbearsoftware.com/samples/testcomplete15/webservices/Service.asmx?WSDL";

  // Specify the service name (as it is specified in its WSDL)
  var serviceName = "SampleWebService";

  // Specify the name of the web service method to be tested
  var methodName = "SetSampleObject";

  // Create a WebServiceInfo object
  var serviceInfo = WebServices["CreateWebServiceInfo"](wsdlURL, serviceName, WebServices["svSoap11"]);

  // Create an object with the method's input parameters
  var requestObj = serviceInfo["PrepareRequestObject"](methodName);

  // Specify the obj method parameter
  // The obj parameter takes an object of the SampleTestClass class
  requestObj["obj"] = serviceInfo["TypeFactory"]["SampleTestClass"];
  requestObj["obj"]["Name"] = "Sample Object";
  requestObj["obj"]["X"] = 5;
  requestObj["obj"]["Y"] = 2.5;
  // Create an array of 5 elements for the obj.IntArray parameter
  var arrayObj = serviceInfo["TypeFactory"]["ArrayOfInt"];
  arrayObj["int"] = BuiltIn["CreateVariantArray"](0, 4);
  // Initialize the array
  for (var i = 0; i < 5; i++)
  {
    arrayObj["int"](i) = i;
  }
  requestObj["obj"]["IntArray"] = arrayObj;

  // Make an XML document for the SOAP request
  var requestXml = serviceInfo["PrepareRequest"](methodName, requestObj);

  // Modify the XML data and add a SOAP header with credentials
  var root = requestXml["documentElement"];

  // Create a Header element and insert it into the request
  var headerElement = requestXml["createElement"]("s:Header");
  var headerNode = root["insertBefore"](headerElement, root["childNodes"]["item"](0));

  // Create a Credentials element and insert it into the header
  var credentialsElement = requestXml["createNode"](1, "Credentials", "http://smartbear.com");
  var credentialsNode = headerNode["appendChild"](credentialsElement);

  // Create a UserID element within the Credentials element
  // and specify the user identifier
  var userIDElement = requestXml["createNode"](1, "UserID", "http://smartbear.com");
  var userIDNode = credentialsNode["appendChild"](userIDElement);
  var userIDValue = requestXml["createTextNode"]("jsmith");
  userIDNode["appendChild"](userIDValue);

  // Create a Password element within the Credentials element
  // and specify the password
  var passwordElement = requestXml["createNode"](1, "Password", "http://smartbear.com");
  var passwordNode = credentialsNode["appendChild"](passwordElement);
  var passwordValue = requestXml["createTextNode"]("1234");
  passwordNode["appendChild"](passwordValue);

  // Create an XMLHTTP object for sending the SOAP request
  xmlHttpRequest = new ActiveXObject("MSXML2.XMLHTTP.3.0");

  // Send the created SOAP request to the web service
  xmlHttpRequest["open"]("POST", serviceURL, false);
  xmlHttpRequest["send"](requestXml);

  // Get the service response
  var responseXML = xmlHttpRequest["responseXML"];
  // Parse the response and post it to the test log
  var response = serviceInfo["ParseResponse"](methodName, responseXML);
  Log["Message"]("Response value: " + response["SetSampleObjectResult"]);

}

The contents of the SOAP request created by the script above and sent to the tested web service method look like the following XML document:

XML

Copy Code

XML

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Credentials xmlns="http://smartbear.com">
      <UserID>jsmith</UserID>
      <Password>1234</Password>
    </Credentials>
  </s:Header>
  <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xmlns:ns1="http://smartbear.com">
    <ns1:SetSampleObject>
      <ns1:obj xsi:type="ns1:SampleTestClass">
        <ns1:X>5</ns1:X>
        <ns1:Y>2.5</ns1:Y>
        <ns1:Name>Sample Object</ns1:Name>
        <ns1:IntArray xsi:type="ns1:ArrayOfInt">
          <ns1:int>0</ns1:int>
          <ns1:int>1</ns1:int>
          <ns1:int>2</ns1:int>
          <ns1:int>3</ns1:int>
          <ns1:int>4</ns1:int>
        </ns1:IntArray>
      </ns1:obj>
    </ns1:SetSampleObject>
  </s:Body>
</s:Envelope>