Versions Compared

Key

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

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

...

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.

...

The following parameters will be returned:

Code Block
languagexml
titleSyntax
<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.

...

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.