Hybrid Integration 10.1 | Integrating On-Premises Applications | Integration Server Built-In Services | SOAP Folder | pub.soap.handler:updateFaultBlock
 
pub.soap.handler:updateFaultBlock
WmPublic. Updates the code, subcodes, reasons, node, and role in an existing fault block.
Input Parameters
messageContext
Object Message context containing the SOAP message that contains the fault block to be updated.
A message context contains properties for the SOAP message and provides access to the SOAP message. Integration Server creates the message context and passes it to the handler. All handlers invoked by a given instance of a SOAP request or SOAP response use the same message context, which enables you to use the message context to pass information among handlers.
If the SOAP Message in messageContext does not contain a SOAP fault, the service returns the status output parameter as false.
soapFault
Document The IData instance to be used to update the values in the fault block.
Key
Description
reasons
Document List Optional. Reasons for the SOAP fault. Each Document in the Document List contains a human readable explanation of the cause of the fault.
Key
Descriptions
*body
String Text explaining the cause of the fault.
@lang
String Optional. Language for the human readable description.
code
Document Optional. Contains the fault code and possible subcodes.
Key
Description
namespaceName
String Namespace name for the SOAP fault code.
localName
String Code that identifies the fault.
subCodes
Document List Optional. Subcodes that provide further detail.
Key
Description
namespaceName
String Namespace name for the subcode.
localName
String Code that identifies the subcode.
node
String Optional. URI to the SOAP node where the fault occurred.
role
String Optional. Role in which the node was operating at the point the fault occurred.
Output Parameters
status
String Flag indicating whether the fault block was updated successfully. A value of:
*true indicates that the fault block was successfully updated.
*false indicates that either a fault block is not present in the messageContext parameter or that the fault block was not successfully updated.
Usage Notes
You can use this service on a provider response handler or fault handler to update the fault block so that the values for code, subcodes, reasons, node, and role that Integration Server generates can be overridden by the custom values you specify.
If you are using this service to override the information in a fault block in a SOAP 1.1 message, keep the following points in mind:
*If multiple reasons are specified, Integration Server uses only the first reason specified because SOAP 1.1 does not support multiple reasons.
*If any subcodes or node values are specified, Integration Server ignores them because subcodes and node elements are not available in the SOAP 1.1 fault structure.
See Also
pub.soap.handler:addFaultBlock
pub.soap.handler:getFaultBlock
Copyright © 2015- 2017 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.