Skip to main content


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

Super class for all SOAP headers

Property Inventory

Method Inventory


OUTPUTTYPEATTRIBUTE allows the programmer to force the xsi:type attribute to be included in all elements of a SOAP message which is a web client request or web service response. If specified, this parameter overrides the OUTPUTTYPEATTRIBUTE of the client or service.


property %headerId as %String);
Header may have a wsu:Id attribute
Property methods: %headerIdDisplayToLogical(), %headerIdGet(), %headerIdIsValid(), %headerIdLogicalToDisplay(), %headerIdLogicalToOdbc(), %headerIdNormalize(), %headerIdSet()
property Fault as %SOAP.Fault (XMLPROJECTION = "none");
Fault which is to be returned by web service based on error importing the header.
Property methods: FaultGet(), FaultGetSwizzled(), FaultIsValid(), FaultNewObject(), FaultSet()
property XmlId as %String);
The xml:id attribute to be added to the header element when writing a SOAP message. Usually wsu:Id will be used, but in certain cases xml:id is needed.
Property methods: XmlIdDisplayToLogical(), XmlIdGet(), XmlIdIsValid(), XmlIdLogicalToDisplay(), XmlIdLogicalToOdbc(), XmlIdNormalize(), XmlIdSet()
property actor as %String (XMLPROJECTION = "none");
SOAP 1.1 uses actor.
Property methods: actorDisplayToLogical(), actorGet(), actorIsValid(), actorLogicalToDisplay(), actorLogicalToOdbc(), actorNormalize(), actorSet()
property mustUnderstand as %Integer (XMLPROJECTION = "none");
Property methods: mustUnderstandDisplayToLogical(), mustUnderstandGet(), mustUnderstandIsValid(), mustUnderstandLogicalToDisplay(), mustUnderstandNormalize(), mustUnderstandSet(), mustUnderstandXSDToLogical()
property role as %String (XMLPROJECTION = "none") [ Calculated ];
SOAP 1.2 uses role instead of actor.
Property methods: roleDisplayToLogical(), roleIsValid(), roleLogicalToDisplay(), roleLogicalToOdbc(), roleNormalize()


method GetId() as %String
Return the value of the Id property. Populate the Id property if it is not yet set.

Inherited Members

Inherited Methods


FeedbackOpens in a new tab