String String specifying the URI of the web service endpoint. If you are submitting the request to an Integration Server, remember to direct it to the default SOAP processor (ws) as shown in the following example:

Document The input parameters that are to be passed to the web service.

String The name of the consumer web service descriptor that contains the operation you want to invoke.

String The name of a binder that contains information to use to create and send the request. This binder must be in the consumer web service descriptor specified in wsdName.

String The name of the operation that you want to invoke. This operation must be contained in the binder specified in wsdBinderName.

String Fully qualified name of the IS document type to use to validate and encode the contents of request.

String Fully qualified name of the IS document type to use to validate and decode the output value returned by the web service.

Document Optional. Header documents included in the SOAP request as SOAP headers.

Document Optional. Transport header fields that you want to explicitly set in the request issued by the pub.client:soapClient service.

Specify a key in transportHeaders for each header field that you want to set, where the key's name represents the name of the header field and the key's value represents the value of that header field.

The names and values supplied to transportHeaders must be of type String. If a transport header has a name or value that is not of type String, the header will not be included in the message.

The headers that you pass in to transportHeaders vary depending on the transport used to send the SOAP message. The supplied wsdBinderName determines the transport.

For more information about specifying transportHeaders, refer to the Usage Notes.

Document Optional. The QName of the requested procedure. The name is defined as follows:

String Namespace portion of the procedure's QName.

String Local portion of the procedure's QName.

Document Optional. Parameters specifying the credentials that are to be submitted to the server specified in address.

Integration Server allows two levels of authorization credentials: transport level and message level.

Each element is defined as follows:

Document Optional. Transport level authorization parameters.

String Optional. Type of authentication that the service will perform. Set to:

String Optional. User name that this service will use if one is requested.

String Optional. Password that this service will submit if one is requested.

Document Optional. The message signer's private key and certificate chain.

privateKey Object The SOAP message signer's private key.

certChain Object List A list containing the signer's complete certificate chain, where element 0 in the list contains the signer's certificate and element 1 contains the CA's certificate.

Document Optional. Message level authorization parameters.

String Optional. User name that this service will use if one is requested.

String Optional. Password that this service will submit if one is requested.

Document Optional. The message signer's private key and certificate chain.

privateKey Object The SOAP message signer's private key.

certChain Object List A list containing the signer's complete certificate chain, where element 0 in the list contains the signer's certificate and element 1 contains the CA's certificate.

Object Optional. The partner's complete certificate chain, where element 0 in the list contains the message signer's certificate and element 1 contains the CA's certificate.

String Optional. Time (measured in milliseconds) to wait for a response from the server hosting the web service before timing out and terminating the request.

A value of 0 means Integration Server waits for a response indefinitely. If the connection to the host or JMS provider ends before Integration Server receives a response, the service ends with an exception and a status code of 408.

If this parameter is not specified, or an invalid (non-numeric) value is specified, Integration Server uses one of the following values:

For more information about watt.server.SOAP.request.timeout and watt.server.soapjms.request.timeout server configuration parameter, see webMethods Integration Server Administrator’s Guide.

Integration Server ignores timeout if the name/value pair jms.async= true is passed in to transportHeaders.

String Optional. Specifies one of the following:

Integration Server ignores soapAction in either of the following situations:

String Optional. Indicates the SOAP protocol the service uses to send messages. Valid values are SOAP 1.1 Protocol or SOAP 1.2 Protocol.

String Optional. Specifies the encoding method. Default value is UTF-8.

Integration Server ignores encoding if the Content-Type header is passed in to transportHeaders.

Object A SOAP object containing the SOAP response message returned by the server specified in address.

Document Output parameters returned from the web service.

Document Conditional. Headers from the response and request messages.

header contains the following keys:

Document Conditional. Header fields from the request message. Each key in requestLines represents a line (field) in the request header. Key names represent the names of header fields. The keys' values are Strings containing the values of the fields.

The contents of the requestLines document are not identical to transportHeaders. The transport can add, remove, or alter specific headers while processing the request.

Whether or not the web service connector returns the requestLines parameter depends on the success or failure of the pub.client:soapClient service. In the case of failure, the point at which the failure occurs determines the presence of the requestLines parameter. For more information, see the usage notes for this service.

For the HTTP or HTTPS transports, the requestLines parameter will not contain any HTTP headers that the transport mechanism added or modified when sending the request.

For the JMS transport, each key in requestLines represents a JMS message header. Key names represent the names of header fields. Key values are Strings containing the values of the header fields. The JMS provider populates some JMS message header fields after it successfully receives the JMS message. Additionally, the Integration Server specific run-time properties (properties that begin with the “jms.” prefix) are not returned in JMS transport, each key in requestLines. The JMS provider uses the information in these properties to populate the JMS message header fields that correspond to the properties.

Document Header fields from the response. Each key in lines represents a field (line) of the response header. Key names represent the names of header fields. The keys' values are Strings containing the values of the fields.

Whether or not the pub.client:soapClient service returns the lines parameter depends on the success or failure of the service. In the case of failure, the point at which the failure occurs determines the presence of the lines parameter. For more information, see the usage notes for this service.

For the HTTP or HTTPS transports, the lines parameter contains any HTTP/HTTPS headers present in the response.

For the JMS transport, the lines parameter contains the JMS headers present in the response.

String Status code from the request, returned by the underlying transport. response. For more information about status codes returned by the service, see the usage notes for this service.

String Status message returned by the transport. For more information about status messages returned by the service, see the usage notes for this service.

String Flag indicating whether the SOAP request message was processed successfully.

The remote server successfully processed the SOAP request and returned a SOAP response message.

The remote server returned a SOAP fault, indicating that the SOAP request was received but was not processed successfully.

The server returned an error that was not a SOAP fault. This indicates that some type of HTTP error occurred (often, an HTTP 404). You can check the status field in header to determine the type of HTTP error that occurred.