Fetching All Accounts of a User
To fetch the details of all accounts that are created for a user, you must use the listUserAccounts operation. This section walks you through the following topics for fetching the details of the user accounts.
aatest
2112880
To fetch the details of all accounts that are created for a user, you must use the listUserAccounts operation. This section walks you through the following topics for fetching the details of the user accounts.
- Preparing the Request Message
- Invoking the Web Service
- Interpreting the Response Message
If you want to fetch details of a particular account, then use the retrieveUserAccount operation. See "Fetch a User Account Details" for more information.
Preparing the Request Message
The listUserAccountRequest message elements are same as those for addUserAccountRequest. See Adding User Accounts for more information.
Invoking the Web Service
To fetch user accounts:
- (Optional) Include the authentication and authorization details in the header of the listUserAccounts operation. See "Managing Web Services Security" for more information on the header elements.
- Use the listUserAccountRequest elements to collect the user account details, as listed in Adding User Accounts.
- Use the listUserAccountRequest message and construct the input message by using the details obtained in preceding step.
- Invoke the listUserAccounts operation of the ArcotUserRegistrySvc service to fetch the account details of the user.This operation returns the listUserAccountResponse message that includes the transaction identifier, authentication token, and user account details. See the following section for more information on the response message.
Interpreting the Response Message
The response message, listUserAccountResponse, returns the transaction identifier and the authentication token in the SOAP envelope header. The SOAP body includes the user account details for a successful transaction and the Fault response for an error condition.
See the following table for more information on the elements returned for a successful transaction. See "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
| |
account/accountType | The attribute that qualifies the account ID and provides additional context about the usage of the account ID. |
account/accountID | The alternate identifier that is used to identify the user in addition to the user name. The account ID is also known as account. |
account/accountStatus | The status of the account. Following are the supported values: 0-9: Indicates that the account is in the INITIAL state. 10-19: Indicates that the account is in the ACTIVE state. 20-29: Indicates that the account is in the INACTIVE state. 30-39: Indicates that the account is in the DELETED state. >39: Indicates that the account state is UNKNOWN. |
account/accountIDAttribute | The alternate identifier that is used to identify the user in the system. |
account/dateCreated | The timestamp when the account ID was created. |
account/dateModified | The timestamp when the account ID was last modified. |
account/accountCustomAttribute | The additional account information that you want to pass as a name-value pair. attributeName Indicates the name of the attribute that you want to create. attributeValue Indicates the corresponding value for the name. |