Previous Topic: Fetching Organization DetailsNext Topic: Fetching RiskMinder Database Attributes

RiskMinder Web Services Developer's Guide › Managing Organizations › Searching Organizations

Searching Organizations

The listOrgs operation is used to simultaneously read the details of multiple organizations. You can search organizations by their organization name, status, and partial or complete display name.

This section walks you through the following steps for searching organizations:

Preparing the Request Message

The listOrgsRequest operation is used to fetch the details of multiple organizations. The following table lists the elements of this request message.

Element

Mandatory

Description

namePattern

No

The search pattern that you want to use to search organizations. You can enter the partial or complete display name of an organization. If you enter the partial name, then all organizations with the display name matching the search pattern will be fetched.

orgName

No

The unique name with which the organization is identified.

Note: If you want to search for more than one organization, then repeat this element for different organizations.

OrgStatus

 

No

The status of the organization in the database:

  • INITIAL
  • ACTIVE
  • INACTIVE
  • DELETED

clientTxId

No

Unique transaction identifier that your calling application can include. This identifier helps in tracking the related transactions.

Invoking the Web Service

To search multiple organizations:

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

    This operation returns the listOrgsResponse 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, listOrgsResponse, 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.