Skip to main content
Previous sectionNext section

SoapBodyUse

Specifies the encoding used by the inputs and outputs of this method, when it is used as a web method. Applies only in a class that is defined as a web service or web client.

Usage

To override the default encoding used by the inputs and outputs of the method (when it is used as a web method), use the following syntax:

Method name(formal_spec) As returnclass [ WebMethod, SoapBodyUse = soapbodyuse ] 
{    //implementation }
Copy code to clipboard

Where soapbodyuse is one of the following:

  • literal (default) — This web method uses literal data. That is, the XML within the <Body> of the SOAP message exactly matches the schema given in the WSDL.

  • encoded — This web method uses SOAP-encoded data. That is, the XML within the <Body> of the SOAP message uses SOAP encoding as appropriate for the SOAP version being used, as required by the following specifications:

Important:

For a web service that you create manually, the default value of this keyword is usually suitable. When you generate a web client or service from a WSDL with the SOAP Wizard, InterSystems IRIS sets this keyword as appropriate for that WSDL; if you modify the value, your web client or service may no longer work.

Details

This keyword specifies the encoding for the inputs and outputs of a web method.

For a given web method, this keyword overrides the SoapBodyUse class keyword.

Default

If you omit this keyword, the value for the SoapBodyUse class keyword is used instead.

Relationship to WSDL and Effect on SOAP Messages

For information, see the entry for the SoapBodyUse class keyword.

Use with %XML.DataSet

If you use this keyword with a method that uses an object of type %XML.DataSet as input or output, some limitations apply. See the entry for the SoapBindingStyle class keyword.

See Also