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

Version 1 Next »

If you wish to update the default Location for a user in the MyAlerts database you will need to call the SetUsersDefaultLocation method.

SetUsersDefaultLocation

Input Parameters

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

LocationId

The unique id for the Location that you wish to set as the default.

Returned Parameters

The following parameters will be returned:

Syntax
<SetUsersDefaultLocationResult>
	<Error>
		<Code>string</Code>
		<Description>string</Description>
	</Error>
	<Success>boolean</Success>
	<LocationId>string</LocationId>
</SetUsersDefaultLocationResult>

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 user's default location will be updated.

LocationId

This is the unique id for the Location.

  • No labels