HS.Util.SOAPAPIHelper
abstract class HS.Util.SOAPAPIHelper
Method Inventory
Methods
classmethod InvokeSOAPService(pSoapTarget, pServiceClassName As %String, pProxyClassName As %String, pMethodName As %String, Output pResponse, pArgs...) as %Status
API Method: Use this to invoke any API web service via SOAP
Inputs:
pSoapTarget - SOAP Service Name to get endpoint
pServiceClassName - Name of the web service class
pProxyClassName - Name of the web service client class
pMethodName - Web service method name
-- See Web Service Client class definition for proper definition of the following items
pResponse - Output Response from service
pArgs... - List of arguments to pass to web service
Note, Ensemble web services return a %Status in pResponse, and the Response object must be defined in the pArgs list.
Non-Ensemble web services will return the response in pResponse.
Examples:
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Hub.HSWS.WebServices","HS.Hub.HSWS.WebServicesClient","ListOIDs",.tResponse)
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Hub.HSWS.WebServices","HS.Hub.HSWS.WebServicesClient","StreamletRequest",.tStatus,tRequest,.tResponse)
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Registry.Person.User.WebServicesAPI","HS.Registry.Person.User.WebServicesAPIClient","QueryWeb",.tResponse,tRequest)
Inputs:
pSoapTarget - SOAP Service Name to get endpoint
pServiceClassName - Name of the web service class
pProxyClassName - Name of the web service client class
pMethodName - Web service method name
-- See Web Service Client class definition for proper definition of the following items
pResponse - Output Response from service
pArgs... - List of arguments to pass to web service
Note, Ensemble web services return a %Status in pResponse, and the Response object must be defined in the pArgs list.
Non-Ensemble web services will return the response in pResponse.
Examples:
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Hub.HSWS.WebServices","HS.Hub.HSWS.WebServicesClient","ListOIDs",.tResponse)
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Hub.HSWS.WebServices","HS.Hub.HSWS.WebServicesClient","StreamletRequest",.tStatus,tRequest,.tResponse)
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Registry.Person.User.WebServicesAPI","HS.Registry.Person.User.WebServicesAPIClient","QueryWeb",.tResponse,tRequest)
classmethod InvokeSOAPServiceWithClientArgs(pSoapTarget, pServiceClassName As %String, pProxyClassName As %String, pMethodName As %String, Output pResponse, ByRef pClientArgs, pArgs...) as %Status
API Method: Use this to invoke any API web service via SOAP and override SOAP client settings for the invoked call
Inputs:
pSoapTarget - SOAP Service Name to get endpoint
pServiceClassName - Name of the web service class
pProxyClassName - Name of the web service client class
pMethodName - Web service method name
-- See Web Service Client class definition for proper definition of the following items
pResponse - Output Response from service
pClientArgs - Arguments to override settings of SOAP client for this call ONLY
pArgs... - List of arguments to pass to web service
Callers should prepare pClientArgs as the following example structure:
pClientArgs("PropertyName1") = PropertyValue1
pClientArgs("PropertyName2") = PropertyValue2
Note, Ensemble web services return a %Status in pResponse, and the Response object must be defined in the pArgs list.
Non-Ensemble web services will return the response in pResponse.
Examples:
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Hub.HSWS.WebServices","HS.Hub.HSWS.WebServicesClient","ListOIDs",.tResponse,.pClientArgs)
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Hub.HSWS.WebServices","HS.Hub.HSWS.WebServicesClient","StreamletRequest",.tStatus,.pClientArgs,tRequest,.tResponse)
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Registry.Person.User.WebServicesAPI","HS.Registry.Person.User.WebServicesAPIClient","QueryWeb",.tResponse,.pClientArgs,tRequest)
Inputs:
pSoapTarget - SOAP Service Name to get endpoint
pServiceClassName - Name of the web service class
pProxyClassName - Name of the web service client class
pMethodName - Web service method name
-- See Web Service Client class definition for proper definition of the following items
pResponse - Output Response from service
pClientArgs - Arguments to override settings of SOAP client for this call ONLY
pArgs... - List of arguments to pass to web service
Callers should prepare pClientArgs as the following example structure:
pClientArgs("PropertyName1") = PropertyValue1
pClientArgs("PropertyName2") = PropertyValue2
Note, Ensemble web services return a %Status in pResponse, and the Response object must be defined in the pArgs list.
Non-Ensemble web services will return the response in pResponse.
Examples:
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Hub.HSWS.WebServices","HS.Hub.HSWS.WebServicesClient","ListOIDs",.tResponse,.pClientArgs)
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Hub.HSWS.WebServices","HS.Hub.HSWS.WebServicesClient","StreamletRequest",.tStatus,.pClientArgs,tRequest,.tResponse)
s tSC=##class(HS.Util.SOAPAPIHelper).InvokeSOAPService("HSREGISTRY","HS.Registry.Person.User.WebServicesAPI","HS.Registry.Person.User.WebServicesAPIClient","QueryWeb",.tResponse,.pClientArgs,tRequest)