Return a User's default Location

Owned by Kim Stimpson
Last updated: 22 Jan, 2015
1 min read

If you wish to return the default Location for a user in the MyAlerts database you will need to call the GetUsersDefaultLocation method. This method is available to developers from the UserManager.asmx Web Service. 

Parameters

 

ClientId

mandatory

This is the id for the client that was returned by the CreateSessionKey method.

SessionKey

mandatory

This is the SessionKey for the client that was returned by the CreateSessionKey method.

UserId

mandatory

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

Name

Requirement

Description

 

Returns

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

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 returned.

LocationId

This is the unique id for the Location.