Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To set the Location information for a User you will need to call the SetLocationValues method.

SetLocationValues

Input Parameters

The SetLocationValues method needs the following parameters:

Image Removed

ClientId 

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.

LocationId

mandatory

This is a unique identifier for the the location record.

LocationName

mandatory

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

DistancemandatoryThis is the distance in metres.  If a change falls within this range, a user will receive an alert.
ActivemandatorySets the record as 1=Active or 0=Inactive.

...

Returned Parameters

...

Name

Requirement

Description

Returns

Code Block
languagexml
titleSyntax
      <SetLocationValuesResult>
        <Error>
          <Code>string</Code>
          <Description>string</Description>
        </Error>
        <Success>boolean</Success>
      </SetLocationValuesResult>

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 location values will be updated.

...