AuthenticateUser

This method is available to developers from the Users.asmx Web Service and is used to authenticate a Username.

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.
Username	mandatory	This is the unique user name for the user as stored in the MyAlerts database.
Password	conditional	The password for the user held in the My Alerts database and is not required for Remote authentication.

Returns

The following will be returned:

Syntax

<AuthenticateUserResult>
        <Error>
          <Code>string</Code>
          <Description>string</Description>
        </Error>
        <AuthenticationKey>string</AuthenticationKey>
        <Success>boolean</Success>
        <UserId>int</UserId>
 </AuthenticateUserResult>

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

1021 – User authentication failed

AuthenticationKey

This is a unique key for the user and is only used within the My Alerts application.

Success

This will be either True or False. If False an error message will be provided in the Error result, if True the UserId and AuthenticationKey will be provided.

UserId

This is the UserId that is held for the supplied Username in the MyAlerts database. If the user does not exist in the My Alerts database then the Success will be returned as False and the user will need to be asked to logon to iShare Maps.