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 3 Current »

If you wish to reset the password for an existing user in the MyAlerts database you will need to call the SetUserPassword method. You would then normally use the SendForgotPassword method to send an email to the user.

SetUserPassword

Input Parameters

The SetUserPassword 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.

Authentication

This is no longer used and may be ignored.

Email

The user’s email address – this entry is required.

NewPassword

The new password for the user.

Returned Parameters

The following parameters will be returned:

Syntax
<SetUserPasswordResult>
	<Error>
		<Code>string</Code>
        <Description>string</Description>
    </Error>
    <Success>boolean</Success
</SetUserPasswordResult>

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

1005 – Email address already exists

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.

  • No labels