Integration Server 10.3 | Built-In Services Reference Guide | SOAP Folder | Summary of Elements in this Folder | pub.soap.handler:getFaultBlock
 
pub.soap.handler:getFaultBlock
WmPublic. Retrieves a fault block from a SOAP message.
Input Parameters
messageContext
Object Message context containing the SOAP message from which to retrieve the fault block.
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.
documentTypes
String List Optional. Fully qualified name of the possible IS document types that could represent the structure of soapFault/detail.
Specify document types that Integration Server created while creating the consumer or the WSDL first provider web service descriptor or ones that were created using the pub.soap.handler:generateDocumentTypesFromWSDL service.
If you do not specify any document type, the service performs a literal conversion of the document; that is, the conversion will not consider style or use.
validate
String Optional. Flag that indicates whether you want the service to validate soapFault/detail against one of the IS document types specified in the documentTypes input parameter.
Set validate to:
*true to validate the contents of soapFault/detail.
To validate the service uses an IS document type from documentTypes that matches the structure. If none of the IS document types specified in documentTypes match, validation fails. If you do not use documentTypes to specify IS document types, the validation fails. If the validation fails, an exception is thrown.
*false to skip validating the contents of soapFault/detail. This is the default.
Output Parameters
Document Contents of the fault block.
Key
Description
soapFault
Document The retrieved fault block.
Key
Description
code
Document Contains the fault code and possible subcodes.
Key
Descriptions
namespaceName
String Namespace name for the SOAP fault code.
localName
String Code that identifies the fault.
subCodes
Document List Subcodes that provide further detail. Each Document in the subCodes Document List contains:
*namespaceName for the subcode
*localName that identifies the subcode
reasons
Document List 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.
node
String URI to the SOAP node where the fault occurred.
role
String Role in which the node was operating at the point the fault occurred.
detail
Document Application-specific details about the SOAP fault.
See Also
pub.soap.handler:addFaultBlock