messageContext | Object Message context containing the SOAP message to which to add a 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. | ||
documentType | String Optional. Fully qualified name of the IS document type that specifies the structure of the document in soapFault/detail. If specified, soapFault/detail must be an instance of this document type. Specify a document type that Integration Server created while creating the consumer or the WSDL first provider web service descriptor or one that was created using the
pub.soap.handler:generateDocumentTypesFromWSDL service. If you do not specify a document type, the service performs a literal conversion of soapFault/detail; that is, the conversion will not consider style or use. | ||
soapFault | Document SOAP fault block that you want to add to the SOAP message. Integration Server converts the document to an XML node and inserts it as a fault block. | ||
Key | Descriptions | ||
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 Optional. One or more subcodes that provide further detail. For each subcode, include a Document in the subCodes Document List; each Document should contain: 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 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. | ||
detail | Document Optional. Application-specific details about the SOAP fault. | ||
validate | String Optional. Flag that indicates whether you want the service to validate soapFault/detail against the IS document type specified in the documentType input parameter. If you do not use documentType to specify an IS document, the validation will fail. Set validate to: true to validate soapFault/detail. If the validation fails, an exception is thrown. false to skip validating soapFault/detail This is the default. |
status | String Flag indicating the outcome of the service. A value of: true indicates that adding the fault block succeeded. false indicates that adding the fault block failed. Note: If the SOAP message already contains a fault block, the service sets status to false. |