Skip to main content

SoapBodyUse (Method Keyword)

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 }

Where soapbodyuse is one of the following:

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, 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.DataSetOpens in a new tab as input or output, some limitations apply. See the entry for the SoapBindingStyle class keyword.

See Also

FeedbackOpens in a new tab