Open Exchange
Global Masters
Home / Class Reference / %SYS namespace / %SOAP.WebRequest
Private  Storage   


class %SOAP.WebRequest extends

%SOAP.WebRequest is class to use XML document for SOAP request.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 3 4


%RequestName Action AddressingIn AddressingOut
Attachments Base64LineBreaks BodyId BodyXmlId
ContentId ContentLocation ContentType GzipOutput
HTTPVersion HeadersIn HeadersOut HttpAccept202
HttpFollowRedirect HttpForceReuseDevice HttpInitiateAuthentication HttpPassword
HttpProxyAuthorization HttpProxyHTTPS HttpProxyPort HttpProxySSLConnect
HttpProxyServer HttpProxyTunnel HttpRequest HttpRequestHeaderCharset
HttpRequester HttpResponse HttpUsername HttpWriteTimeout
ImportHandler IsMTOM KeepSessionCookie Location
MTOMRequired MethodName NamespacesOut OneWay
OpenTimeout OutputTypeAttribute Password PolicyConfiguration
RMSession ReferencesInline Request RequestMessageStart
Response ResponseAttachments ResponseContentId ResponseContentLocation
SAXFlags SSLCheckServerIdentity SSLConfiguration SSLError
SecurityContextToken SecurityIn SecurityNamespace SecurityOut
SessionCookie SoapBinary SoapBinaryCharset SoapFault
SoapVersion Timeout Transport UsePPGHandler
Username WSANamespace WriteSOAPBodyMethod policyAlternative

%%OIDGet %AddEnvelopeNamespace %AddToSaveSet %BindExport
%BuildObjectGraph %ClassIsLatestVersion %ClassName %Close
%CloseRMSession %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IncrementCount
%IsA %IsModified %New %NormalizeObject
%ObjectModified %OnSOAPFinished %OnSOAPRequest %OnSOAPResponse
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %StartRMSession %ValidateObject BeginSOAPEnvelope
CancelSecureConversation CheckSOAPEnvelope DoSOAPRequest EndSOAPEnvelope
GetBinaryWriter GetBodyId GetSecurityOut GetSoapParameters
InitializeSecurity InvokeClient LogGlobal LogInput
LogInputHTTPHeaders LogOutput LogOutputHTTPHeaders LogText
Namespace NormalizeName OnCompile ProcessSOAPEnvelope
ReadBinaryMessage ResetHttpHeaders ResetSecurity ReturnResponse
SOAPRequestResponse SecurityOutGet SecurityOutSet SendSOAPBody
SendSOAPRequest SessionCookieSet SessionCookieSetInternal SetHttpHeader
SoapBinarySet StartSecureConversation WSCheckSignatureConfirmation WSSecurityLogin
WebMethod WriteBody WriteHTTPContent WriteSOAPHeaders
WriteSOAPMessage WriteStartAttachments


• parameter SERVICENAME = "XMLBody";
Dummy service name when used to just send XML body


• property %RequestName as %String;
Dummy %RequestName
• property Request as %RegisteredObject;
Request stream
• property Response as %RegisteredObject;
Response stream


• classmethod GetSoapParameters(ByRef bindingStyle As %String, ByRef bodyUse As %String, ByRef namespace As %String, ByRef xmlimportnamespace As %String, ByRef typeNamespace As %String, ByRef oneWay As %Boolean, ByRef xmlelement As %Boolean, ByRef bare As %Boolean)
Return document/literal parameters for sending an XML body
• method ReturnResponse(document As %XML.Document, messageId As %String) as %Status
Callback from %SOAP.WebClient to return the response body.
• method SendSOAPBody(Action As %String, OneWay As %Boolean = 0, Request As %CharacterStream, ByRef Response, methodName As %String) as %Status
The SendSOAPBody method of %SOAP.WebClient will send an XML document as the body of a SOAP request and return the response body as an XML document. The arguments to this method are:
Action is the SOAPAction for the SOAP request.
If OneWay is 1 (true) then no response is expected.
Request is the body of the SOAP request in the character set of the current locale.
Response will be set to the body of the SOAP response message either as a stream or %XML.Node. If Response is a character stream, the body of the SOAP response will be written in the character set of the current locale.
If Response is "", then a new character stream will be created and assigned to Response.
If Response is an %XML.Node, then the %XML.Node will be set to point to the body DOM.
methodName is an optional name of the method being called which is used to select the WS-Policy.
The Location property of %WebClient must be set to the endpoint of the web service before SendSOAPBody is called.
Properties of %SOAP.WebClient such as HeadersIn, HeadersOut, Timeout, etc. may be used with the SendSOAPBody call.
• method WriteBody(proxy, tag) as %Status
WriteBody method is used internally as the callback to create the SOAP body