Fetching Default Organization Details

RiskMinder Web Services Developer's Guide › Managing Organizations › Fetching Default Organization Details

Fetching Default Organization Details

The Master Administrator (MA) sets the default organization details in the system. Typically, when you create administrators or enroll users without specifying their organization, they are created in this default organization. The retrieveDefaultOrg operation is used to fetch the details of the default organization.

This section walks you through the following steps for fetching the details of the default organization:

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

Preparing the Request Message

The retrieveDefaultOrgRequest message is used to fetch the default organization information. The following table lists the elements of this request message.

Element	Mandatory	Description
clientTxId	No	Unique transaction identifier that your calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To fetch the default organization information:

(Optional) Include the authentication and authorization details in the header of the retrieveDefaultOrg operation. See "Managing Web Services Security" for more information on the header elements.
Use the retrieveDefaultOrgRequest elements for fetching the default organization information, as listed in the table.
Use the retrieveDefaultOrgRequest message and construct the input message by using the details specified in the preceding step.
Invoke the retrieveDefaultOrg operation of the ArcorUserRegistryMgmtSvc service to fetch the default organization details.
This operation returns the retrieveDefaultOrgResponse message that includes the transaction identifier, authentication token, and default organization details. See the following section for more information on the response message.

Interpreting the Response Message

The response message, retrieveDefaultOrgResponse, returns the transaction identifier, authentication token, and other details in the SOAP envelope header. The SOAP body includes the default organization details 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
orgName	The unique name of the organization.
displayName	The descriptive name of the organization.
repositoryDetails	The repository where the accounts of the users who belong to the organization reside: ARUSER LDAP
dateCreated	The timestamp when the organization was created.
dateModified	The timestamp when the organization configuration was last modified.
description	The description for the organization that helps the administrators managing the organization.
status	The status of the default organization in the database: INITIAL ACTIVE INACTIVE DELETED
preferredLocale	The locale configured for the organization. If you do not specify the locale, then the default locale is set to en-US.
customAttribute	The name-value pairs of the custom attributes that have been set for the organization.