Skip to main content


class %SOAP.Fault12 extends %Library.RegisteredObject, %XML.Adaptor

class to represent a SOAP 1.2 fault. %SOAP.Fault12 should only be used if SOAPVERSION is set to "1.2" or that at least SoapVersion="1.2" meaning that this web service request is SOAP 1.2 is format. The %SOAP.Fault class will work with SOAP 1.1 or SOAP 1.2. However, the fault functionality is limited to that of SOAP 1.1 fault.

Property Inventory

Method Inventory


parameter NAMESPACE =;
Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. If NAMESPACE = "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLTYPE = Fault;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property Code as %SOAP.Fault12.Code [ Required ];
The SOAP fault code as defined in the SOAP definition.
Property methods: CodeGet(), CodeGetSwizzled(), CodeIsValid(), CodeNewObject(), CodeSet()
property Detail as %XML.String);
XML element that gives error details. The contents of detail will not be escaped.
Property methods: DetailDisplayToLogical(), DetailGet(), DetailIsValid(), DetailLogicalToDisplay(), DetailLogicalToOdbc(), DetailNormalize(), DetailSet()
property Node as %String);
Node that generated the fault. Optional for the destination node.
Property methods: NodeDisplayToLogical(), NodeGet(), NodeIsValid(), NodeLogicalToDisplay(), NodeLogicalToOdbc(), NodeNormalize(), NodeSet()
property Reason as list of %SOAP.Fault12.Text (XMLITEMNAME = "Text") [ Required ];
Human readable message
Property methods: ReasonBuildValueArray(), ReasonCollectionToDisplay(), ReasonCollectionToOdbc(), ReasonDisplayToCollection(), ReasonGet(), ReasonGetObject(), ReasonGetObjectId(), ReasonGetSwizzled(), ReasonIsValid(), ReasonOdbcToCollection(), ReasonSet(), ReasonSetObject(), ReasonSetObjectId()
property Role as %String);
Role that the node was operating in.
Property methods: RoleDisplayToLogical(), RoleGet(), RoleIsValid(), RoleLogicalToDisplay(), RoleLogicalToOdbc(), RoleNormalize(), RoleSet()
property faultPrefixDefinition as %String);
Optional prefix definition attribute to be added to Fault element. Usually of the form xmlns:prefix="namespace"
Property methods: faultPrefixDefinitionDisplayToLogical(), faultPrefixDefinitionGet(), faultPrefixDefinitionIsValid(), faultPrefixDefinitionLogicalToDisplay(), faultPrefixDefinitionLogicalToOdbc(), faultPrefixDefinitionNormalize(), faultPrefixDefinitionSet()


method AsString() as %String
Return this SOAP fault as a string.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab