Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

If you wish to update the password for an existing user in the MyAlerts database a user wishes to change their password you will need to call the UpdatePassword method.

UpdatePassword

Input Parameters

The UpdatePassword method needs the following 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.

UserId

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

OldPassword

The user’s original password.

NewPassword

The new password for the user.

Returned Parameters

The following parameters will be returned:

Code Block
languagexml
titleSyntax
<UpdatePasswordResult>
	<Error>
		<Code>string</Code>
        <Description>string</Description>
    </Error>
    <Success>boolean</Success
</UpdatePasswordResult>

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

Success

This will be either True or False. If False an error message will be provided in the Error result, if True the the user's password will be updated.