Checking the User Status

RiskMinder Web Services Developer's Guide › Managing Users and Accounts › Performing User Operations › Checking the User Status

Checking the User Status

You must use the getUserStatus operation to know the current status of the user in the database.

This section walks you through the following steps for checking the user status:

Preparing the Request Message
Invoking the Web Service
Interpreting the Response Message

Preparing the Request Message

The following table lists the elements of the getUserStatusRequest message.

Element	Mandatory	Description
userId/orgName	No	The name of the organization to which the user belongs. Note: If the organization name is not passed, then the Default Organization is used for the operation.
userId/userName	Yes	The unique identifier with which the user is identified in the system.
userId/userRefId	No	The identifier used as a reference to track different operations performed by a user.
clientTxId	No	The unique transaction identifier that your calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To check the user status:

(Optional) Include the authentication and authorization details in the header of the getUserStatus operation. See "Managing Web Services Security" for more information on the header elements.
Use the getUserStatusRequest elements to collect the user details, as listed in the table.
Use the getUserStatusRequest message and construct the input message by using the details specified in the preceding step.
Invoke the getUserStatus operation of the ArcorUserRegistrySvc service to check the user status.
This operation returns the getUserStatusResponse message that includes the transaction identifier, authentication token, and user details and status. See the following section for more information on the response message.

Interpreting the Response Message

The response message, getUserstatusResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. The SOAP body includes the user details and status for a successful transaction, and the Fault response for an error condition.

See the following table for more information on the elements returned for a successful transaction. Refer to appendix, "Exceptions and Error Codes" if there are any errors.

Element	Description

Header Elements
udsTransactionID	The unique identifier of the transaction performed by using UDS.
authToken	The authentication token that is returned if the credential verification to access the Web service was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web service. By default, the authentication token is valid for one day, after which you need to authenticate again.
Body Elements
userId/orgName	The name of the organization to which the user belongs.
userId/userName	The unique identifier with which the user is identified in the system.
userId/userRefId	The identifier used as a reference to track different operations performed by a user.
status	The status of the user: INITIAL ACTIVE INACTIVE DELETED