Fetching Configurations

CA AuthMinder Web Services Guide › Managing AuthMinder Configurations › Fetching Configurations

Fetching Configurations

The fetch operation is used to fetch configurations.

This section walks you through the following topics for fetching configuration details:

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

Preparing the Request Message

The fetchRequest message is used to fetch configuration details. The following table lists the common elements of this request message that are applicable to all credentials:

Element	Mandatory	Description

clientTxnId	No	Unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.
Additional Input (additionalInput) Elements
pairs	No	AuthMinder’s additionalInput element enables you to set additional inputs if you want to augment AuthMinder’s authentication capability by specifying additional information. In such cases, you need to set the extra information in name-value pairs. name (The name with which you want to create the key pair.) value (The corresponding value for name.) Note: You can add more than one of these elements. Some of the pre-defined additional input parameters include: AR_WF_LOCALE_ID Specifies the locale that AuthMinder will use while returning the messages back to your calling application. AR_WF_CALLER_ID This is useful in tracking transactions. You can use session ID or client transaction ID (clientTxnId) for specifying this information.
Organization Detail (configurationNames/orgDetails) Elements
orgName	Yes	Fetches the configurations that are used by the specified organizations.
OR
isGlobal	Yes	Indicates if you want to fetch the configuration applied at the global-level.
Configuration Elements The following two elements are applicable to all configurations (configurationNames/configurationname<Names>).
configNames	No	Fetches the configuration names for a particular organization.
isAllConfigs	No	Indicates whether all configurations must be fetched.
isFetchOnlyNames	No	Indicates whether only the configuration name has to be fetched.

Invoking the Web Service

To fetch configuration details:

(Optional) Include the authentication and authorization details in the SOAP header or in the additionalInput element of the fetch operation. See chapter, "Managing Web Services Security" for more information on these details.
Use the FetchRequest elements to fetch the configuration details, as listed in the preceding table.
Use the FetchRequest message and construct the input message by using the details obtained in the preceding step.
Invoke the fetch operation of the ArcotWebFortAdminSvc service to fetch the configuration details.

Interpreting the Response Message

For successful transactions, the response message, fetchResponse returns the elements explained in the following table. These elements are included in the SOAP body. If there are any errors, then the Fault response is included in the SOAP body. See appendix, "Error Codes" for more information on the SOAP error messages.

Element	Description
message	Indicates the status of the transaction.
reasonCode	Unique code that is sent by AuthMinder Server if the operation fails.
responseCode	Code returned by the SDK in case of errors.
transactionID	The unique identifier of the transaction.
additionalOutput	The return values of the additional input.
configurations	Returns the following: configurationObjects: The configured objects. configurationNames: The names of the configurations.