Fetching QnA Configuration

CA AuthMinder Web Services Guide › Performing Credential Operations › Fetching QnA Configuration

Fetching QnA Configuration

The number of questions that the user must set for QnA authentication might vary for every organization. This section explains how to use Web services to fetch the questions that are set for each organization. It covers the following topics:

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

Preparing the Request Message

The FetchQnAConfigurationRequestMessage is used to get the number of questions that must be set by the user. It contains the elements listed in the following table:

Element	Mandatory	Description
clientTxnId	No	Specifies the unique transaction identifier that the calling application can include. This identifier helps in tracking the related transactions.
orgName	No	Specifies the organization name to which the user belongs to.
profileName	No	Specifies the profile name of the credential. If it is not passed, then the default profile for the organization is used.
fetchQuestions	No	Specifies whether to fetch the user questions. Following are the possible values: 0: If you do not want to fetch the questions. 1: If you want to fetch the questions.
additionalInput/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.

Invoking the Web Service

Perform the following steps to fetch QnA configuration:

(Optional) Include the authentication and authorization details in the SOAP header or in the additionalInput element of the FetchQnAConfiguration operation. See chapter, "Managing Web Services Security" for more information on these details.
Use the orgName element to fetch the QnA details configured for the organization.
(Optional) If you are implementing a plug-in, then invoke the additionalInput element type to fill the additional input.
This type provides the additional information that is set as a name-value pair.
Use FetchQnAConfigurationRequestMessage and construct the input message by using the details obtained in preceding steps.
Invoke the FetchQnAConfiguration operation of the ArcotWebFortIssuanceSvc service to fetch the number of questions.
This operation returns an instance of the FetchQnAConfigurationResponseMessage that includes the credential and transaction details.

Interpreting the Response Message

For successful transactions, the response message, FetchQnAConfigurationResponseMessage 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 , "Error Codes" for more information on the SOAP error messages.

Element	Description
orgName	The organization name to which the user belongs to.
profileName	The profile name of the credential.
minQuestions	The minimum number of questions that must be set by the user.
maxQuestions	The maximum number of questions a user can set.
questions	The questions for authenticating the users. Note: The questions are returned if fetchQuestions flag is enabled in the input.
transactionDetails	The transactions details include the following: message A string that defines the status of the operation. reasonCode Unique code that is sent by AuthMinder Server if the operation fails. responseCode Unique code that is sent by AuthMinder Server if the operation fails. transactionID Unique identifier of the transaction. additionalOutput The output for the additionalInput that was passed to AuthMinder Server.