Retrieve User Details
- Kim Stimpson
If you wish to retrieve the details for a user you will need to call the GetUserDetails method. This method is available to developers from the Users.asmx Web Service.
Parameters
Name | Requirement | Description |
|---|---|---|
ClientId | mandatory | This is the id for the client that was returned by the CreateSessionKey method. |
SessionKey | mandatory | This is the SessionKey for the client that was returned by the CreateSessionKey method. |
UserId | mandatory | This is the unique user id for the user as stored in the My Alerts database. |
Returns
<GetUserDetailsResult>
<Error>
<Code>string</Code>
<Description>string</Description>
</Error>
<Success>boolean</Success>
<UserDetails>
<Firstname>string</Firstname>
<Lastname>string</Lastname>
<Nickname>string</Nickname>
<Email>string</Email>
<Tel>string</Tel>
<Username>string</Username>
<Password>string</Password>
</UserDetails>
</GetUserDetailsResult>
Error - Code / Description
An error code and description if the call to the web service is unsuccessful and the Success if False.
1001 – Invalid Session key provided
1022 – User not found in My Alerts database
Success
This will be either True or False. If False an error message will be provided in the Error result, if True the UserDetails will be provided.
UserDetails
A UserDetails entry will be returned with the following entries:
Firstname
The first name for the user.
Lastname
The last name for the user.
Nickname
The nick name for the user.
The email address for the user.
Username
This is the unique user name for the user as stored in the My Alerts database.
Password
The password for the user as stored in the My Alerts database.