Return the Locations set for a User

Owned by Kim Stimpson
Last updated: 19 Feb, 2015
1 min read

If you wish to return a list of Locations which a user has added then you will need to call the GetUserLocations 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
<GetUserLocationsResult>
	<Error>
		<Code>string</Code>
		<Description>string</Description>
	</Error>
	<Success>boolean</Success>
	<Locations>
		<UserLocationDefinition>
			<LocationId>string</LocationId>
			<LocationName>string</LocationName>
			<TypeId>int</TypeId>
			<Geography>string</Geography>
			<UniqueId>string</UniqueId>
			<Distance>double</Distance>
			<Active>boolean</Active>
		</UserLocationDefinition>
		<UserLocationDefinition>
			<LocationId>string</LocationId>
			<LocationName>string</LocationName>
            <TypeId>int</TypeId>
			<Geography>string</Geography>
            <UniqueId>string</UniqueId>
            <Distance>double</Distance>
            <Active>boolean</Active>
		</UserLocationDefinition>
	</Locations>
</GetUserLocationsResult>

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 list of UserLocationDefinition entries will be returned.

UserLocationDefinition

A UserLocationDefinition entry will be returned for each Location with the following details:

LocationId

This is the unique id for the Location.

LocationName

This is a text field, usually containing the address - for example "22, TANGLEWOOD CLOSE, WOKING, SURREY, GU22 8LG"

TypeId

This is always set to 1.

Geography

This is the X,Y coordinates for the location - These can be derived from the AstunLocationLookup table and take the form "POINT(502582.58412372, 159186.49997736)"

UniqueID

This corresponds with the UniqueId on the AstunLocationLookup table.

Distance

This is the distance in metres.  If a change falls within this range, a user will receive an alert.

Active

Sets the record as 1=Active or 0=Inactive.