Skip to main content

HS.Registry.Person.User.WebServicesAPIClient

class HS.Registry.Person.User.WebServicesAPIClient extends %SOAP.WebClient

Method Inventory

Parameters

parameter LOCATION;
This is the URL used to access the web service.
parameter NAMESPACE = http://www.intersystems.com/hs/registry/person/user;
This is the namespace used by the Service
parameter OUTPUTTYPEATTRIBUTE = 1;
Use xsi:type attribute for literal types.
parameter SERVICENAME = HS.Registry.Person.User.WebServicesAPI;
This is the name of the Service

Methods

method AddUserWeb(pRequest As HS.Registry.Person.User.WebServices.Containers.SuperContainer) as %Status [ WebMethod ]
Note - all ID properties in the supercontainer must be null. At least one identifier (UserID or Domain+Login or AA+identifier) must be non-null
method CheckUserPermissions(pResource As %String, pPrivilege As %String, pLoginDomain As %String, pUserIdList As %Library.ListOfDataTypes, pRegistryIdList As %Library.ListOfDataTypes) as HS.Registry.Person.User.WebServices.Containers.MultiUserContainer [ WebMethod ]
External webmethod to check which of a list of users have access to a resource
method DeactivateUserWeb(pToken As %Integer, pInternalId As %String) as %Status [ WebMethod ]
This must be preceded by a call to Query, to get the token as well as the internal ID. The token expires after 15 minutes
method EditUserWeb(pToken As %Integer, pRequest As HS.Registry.Person.User.WebServices.Containers.SuperContainer) as %Status [ WebMethod ]
External webmethod. This must be preceded by a call to Query, to get the token as well as the internal ID. The token expires after 15 minutes
method IsDomainTwoFactor(pDomain As %String) as %Boolean [ WebMethod ]
External webmethod to list all phone providers, for two-factor authentication
method ListPhoneProviders() as HS.Util.WebServices.ListItems [ WebMethod ]
External webmethod to list all phone providers, for two-factor authentication
method LoadUserWeb(pToken As %Integer, pInternalId As %String) as HS.Registry.Person.User.WebServices.Containers.SuperContainer [ WebMethod ]
External webmethod. This must be preceded by a call to Query, to get the token as well as the internal ID. The token expires after 15 minutes
method MergeUsersWeb(pTokenFrom As %Integer, pInternalIdFrom As %String, pTokenInto As %Integer, pInternalIdInto As %String) as %Status [ WebMethod ]
External webmethod to merge two user/clinicians. Note that this does not do anything about delivery policies or subscriptions - those require a human to look at them and edit via the UI This must be preceded by call(s) to Query, to get the tokens as well as the internal IDs. Each token expires after 15 minutes
general query by identifiers. Multiple queries may be done, and each will get a response

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab