GetSOAPRequest

Description

Returns an XML object that contains the entire SOAP request. Usually called from within a web service CFC.

Returns

An XML object that contains the entire SOAP request.

Category

XML functions

History

ColdFusion MX 7: Added this function.

Function syntax

GetSOAPRequest()

See also

AddSOAPRequestHeader, AddSOAPResponseHeader, GetSOAPRequestHeader, GetSOAPResponse, GetSOAPResponseHeader, IsSOAPRequest; Basic web service concepts in the Developing ColdFusion Applications

Parameters

Parameter

Description

webservice

Optional. A webservice object as returned from the cfobject tag or the CreateObject function.

Required if the function is called from the client.

Usage

Call this function to obtain a web service request object after the web service has been invoked. If you call this function from outside a web service CFC without the webservice parameter, it throws the following expression error:

Unable to use getSOAPRequest: not processing a web service request.

If you call this function from within a web service CFC, you can omit the webservice argument. The function executes against the request that it is currently processing.

You can use CFML XML functions to examine the returned XML object.

Example

This example makes a request to execute the echo_me function of the headerservice.cfc web service. For information on implementing the headerservice.cfc web service and also to see the echo_me function and the content of the web service CFC, see the example for either the AddSOAPResponseHeader function or the GetSOAPRequestHeader function.

<!--- Note that you might need to modify the URL in the CreateObject function 
to match your server and the location of the headerservice.cfc file if it is 
different than shown here.  
Note, too, that getSOAPRequest is called from the client here, whereas often it 
would be called from within the web service CFC. ---> 
 
<cfscript> 
    ws = CreateObject("webservice", 
"http://localhost/soapheaders/headerservice.cfc?WSDL"); 
    ws.echo_me("hello world"); 
    req = getSOAPRequest(ws); 
</cfscript> 
<cfdump var="#req#">