Return Layer Groups subscribed to by a User
If you wish to return a list of Layer Groups to which a user has subscribed then you will need to call the GetUserLayerGroups method. his 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. |
LocationId | mandatory | This is the unique id for the Location. |
Name | Requirement | Description |
---|
Returns
<GetUserLayerGroupsResult> <Error> <Code>string</Code> <Description>string</Description> </Error> <UserId>int</UserId> <Success>boolean</Success> <LayerGroups> <UserLayerGroupDefinition> <LayerGroupId>string</LayerGroupId> <LayerGroupName>string</LayerGroupName> <MapSourceId>string</MapSourceId> <MapSourceName>string</MapSourceName> <LocationId>string</LocationId> </UserLayerGroupDefinition> <UserLayerGroupDefinition> <LayerGroupId>string</LayerGroupId> <LayerGroupName>string</LayerGroupName> <MapSourceId>string</MapSourceId> <MapSourceName>string</MapSourceName> <LocationId>string</LocationId> </UserLayerGroupDefinition> </LayerGroups> </GetUserLayerGroupsResult>
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 UserLayerGroupDefinition entrieswill be returned.
UserLayerGroupDefinition
A UserLayerGroupDefinition entry will be returned for each Layer Group with the following details:
LayerGroupId
This is the unique id for the LayerGroup.
LayerGroupName
This is the name for the LayerGroup.
MapSourceId
This is the unique id for the MapSource.
MapSourceName
his is the name for the MapSource.
LocationID
This is the unique id for the Location.