Login a User

If you wish to log in a user once the user has been authenticated you will need to call the LoginUser 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.
AuthenticationKey	mandatory	This is the AuthenticationKey for the user that was returned by the Authenticate a My Alerts User method.

Returns

Syntax

<LoginUserResult>
        <Error>
          <Code>string</Code>
          <Description>string</Description>
        </Error>
        <SessionKey>string</SessionKey>
        <Success>boolean</Success>
        <UserId>int</UserId>
</LoginUserResult>

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

SessionKey

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 SessionKey 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 you will need to call the CreateUser method to add the user to the database.