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.
GetUserLocations
...
Parameters
The GetUserLocations method needs the following 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 |
...
Returned Parameters
...
My Alerts database. | ||
Name | Requirement | Description |
|---|
Returns
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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:
...