Fetching Account Types

CA AuthMinder Web Services Guide › Configuration Management Web Service › Managing Account Types › Fetching Account Types

Fetching Account Types

The listAccountTypes operation is used to fetch the account types that are associated with an organization.

This section walks you through the following topics for fetching the account types:

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

Preparing the Request Message

The listAccountTypeRequest message is used to fetch account types that are associated with an organization. The following table lists the elements of this request message:

Element	Mandatory	Description
targetAllOrgs	Yes	Indicates whether to fetch the account types assigned to all the organizations. Following are the supported values: true: Account types assigned to all the organizations are fetched. false: Account types assigned to the organizations that are listed in the orgName element are fetched.
orgName	No	The name of the organization to which the account types to be fetched belongs.
clientTxId	No	Unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.

Element

Mandatory

Description

targetAllOrgs

Yes

Indicates whether to fetch the account types assigned to all the organizations. Following are the supported values:

true: Account types assigned to all the organizations are fetched.
false: Account types assigned to the organizations that are listed in the orgName element are fetched.

orgName

The name of the organization to which the account types to be fetched belongs.

clientTxId

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

Invoking the Web Service

To list the account types of an organization:

(Optional) Include the authentication and authorization details in the header of the listAccountTypes operation. See chapter , "Managing Web Services Security" for more information on the header elements.
Use the listAccountTypeRequest elements to set the account information.
Use listAccountTypeRequest message and construct the input message by using the details obtained in preceding step.
Invoke the listAccountTypes operation of the ArcotConfigRegistrySvc service to list the account types.
This operation returns the listAccountTypeResponse message that includes the transaction identifier, authentication token, and the account types associated with an organization. See the following section for more information on the response message.

Interpreting the Response Message

The response message, listAccountTypeResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. The SOAP body includes the account type details for a successful transaction, and the fault response for an error condition.

The following table provides more information about the elements returned for a successful transaction. See appendix "Error Codes" if there are any errors.

Element	Description

Header Elements
udsTransactionID	The unique identifier of the transaction that is performed using UDS.
authToken	The authentication token that is returned if the credential verification to access Web services was successful. This token eliminates the need for you to present the authentication credential for successive access to the Web services. By default, the authentication token is valid for one day, after which you need to authenticate again.
Body Elements
AccountType/name	The name of the account type.
AccountType/displayName	The descriptive name of the account type.
AccountType/customAttribute	Name-value pairs that are used to specify additional account type information.