Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

To authenticate a username you will need to call the AuthenticateUser method.

AuthenticateUser

Input Parameters

The AuthenticateUser method needs the following parameters:

AuthenticateUser Input parameters

ClientId

This is the id for the client that was returned by the CreateSessionKey method.

SessionKey

This is the SessionKey for the client that was returned by the CreateSessionKey method.

Username

This is the unique user name for the user as stored in the MyAlerts database.

Password

The password for the user held in the MyAlerts database and is not required for Remote authentication.

Returned Parameters

The following parameters 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 MyAlerts 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 MyAlerts database then the Success will be returned as False and the user will need to be asked to logon to iShareMaps.

  • No labels