Skip to end of metadata
Go to start of metadata

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

Compare with Current View Version History

« Previous Version 3 Next »

If you wish to update the details for an existing user in the MyAlerts database you will need to call the SetUserDetails method.

SetUserDetails

Input Parameters

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

Password

The password for the user – this entry is required when coming from iShare Maps portal.

Email

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

Firstname

The Christian names for the user – this entry is not compulsory.

Lastname

The Last name for the user – this entry is not compulsory.

Tel

The telephone number for the user – this entry is not compulsory

Nickname

The nickname for the user – this entry is not compulsory.

Returned Parameters

The following parameters will be returned:

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

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

1023 – Required fields incomplete

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 details will be updated.

  • No labels