Previous Topic: Fetching Default Organization DetailsNext Topic: Searching Organizations

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

Fetching Organization Details

The retrieveOrg operation is used to read the details of an organization.

Note: If you want to fetch details of multiple organizations at the same time, then use the listOrgs operation. See "Searching Organizations" for more information on how to use this.

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

Preparing the Request Message

The retrieveOrgRequest is used to fetch the details of an organization. The following table lists the elements of this request message.

Element

Mandatory

Description

orgName

Yes

The unique name with which the organization is identified.

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 organization details:

  1. (Optional) Include the authentication and authorization details in the header of the retrieveOrg operation. See "Managing Web Services Security" for more information on the header elements.
  2. Use the retrieveOrgRequest elements for fetching the organization details, as listed in the table.
  3. Use the retrieveOrgRequest message and construct the input message by using the details specified in the preceding step.
  4. Invoke the retrieveOrg operation of the ArcorUserRegistryMgmtSvc service to fetch the organization details.

    This operation returns the retrieveOrgResponse message that includes the transaction identifier, authentication token, and organization details. See the following section for more information on the response message.

Interpreting the Response Message

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

See the second table in Fetching Default Organization Details for more information on the elements returned for a successful transaction. Refer to appendix, "Exceptions and Error Codes" if there are any errors.