RequestBase

Most IEE services accept a single parameter as input. This parameter is a request element that inherits from RequestBase.

The following illustration shows the RequestBase element schema:

RequestBase element schema

The following is a list of RequestBase elements:

  • CorrelationID. IEE does not require, validate, or perform any processing against the contents of this element. IEE performs the following with the CorrelationID:

  • Reflects the CorrelationID back in the initial response.

  • Passes the CorrelationID to any downstream systems if applicable.

  • Sends the CorrelationID in any asynchronous callback to a Receive service.

The client application defines the content of the CorrelationID and passes in a unique value if it wants to use the CorrelationID to match requests and responses.

  • ErrorProcessingInstructions. Gets or sets instructions on how the service returns error information. This element contains the following sub-elements:

  • ReturnFaultInResponse. If true, the service does not use SOAP faults to return errors to the client. Instead, the presence of a Fault element in the response indicates an error. This parameter defaults to true if not specified. In some cases, the web service infrastructure returns a SOAP fault, regardless of the ReturnFaultInReponse parameter (for example, when a client attempts to connect with the service in a way that violates the configured security policy).

  • ReturnLogMessages. If true, the service returns additional messages that were logged during the processing of the service call in the ServiceLogMessages element. This parameter defaults to true if not specified.

  • ReturnLogMessageLevel. If ReturnLogMessages is true, this parameter specifies the minimum severity of the messages that are returned. Only messages of the specified severity or higher are returned. This parameter defaults to Warning if not specified.

  • Locale. Determines a locale string that causes the service to return data localized to the specified locale. Generally, this only applies to string data, as other XML data types are locale independent. If not specified, data is returned in the locale that is centrally configured in IEE.

  • RequestingUserName. The name of the user that originated the request.