- Contents
SOAP API Developer's Guide
SOAP Create Fault Response
Copies the request envelope and replaces all children of the <Body> element with a single <Fault> element. It thus combines the ‘SOAP Create Envelope' and ‘SOAP Set Fault' tools. The selection namespaces from the source envelope document are copied to the response envelope document as well.
Exit Paths: Success, Failure
Parameter |
Dir |
Type |
Remarks |
Envelope |
IN |
Node |
Envelope node of the request SOAP payload. Can be a document node whose document element is <SOAP-ENV:Envelope> or the node is the element itself. |
Fault Code |
IN |
String |
String to set as value of the <faultcode> element. String must not be empty. |
Fault String |
IN |
String |
String to set as value of the <fautstring> element. Should be set to provide human readable information. |
Fault Actor |
IN |
String |
Optional. String to set as value of the <faultactor> element. If argument is not specified, no <faultactor> element is added. |
Create Detail Element |
IN |
Boolean |
Checkbox: False Don't create a <detail> element True Default. Create an empty <detail> element NOTE: According to the SOAP spec, a <detail> element must be present if the fault is because the <Body> could not be processed successfully. |
Copy Header |
IN |
Boolean |
Checkbox: False Does not copy the <Header> element from the source envelope. True Copies the <Header> element and its content from the source envelope. |
Response Envelope |
OUT |
Node |
Document node of the response envelope |
Detail Element |
OUT |
Node |
Node of the <detail> element of the <Fault> element. If ‘Create Detail Element' is False, a NULL node is returned. |