Versions Compared

Key

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

If you wish to return a list of users registered in the My Alerts database you will need to call the GetFullUserList method.  This method is available to developers from the Users.asmx Web Service and returns a list of users registered in the My Alerts database.

Parameters

 

Name

Requirement

Description

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.

 

Returns

 

Code Block
languagexml
titleSyntax
      <GetFullUserListResult>
        <Error>
          <Code>string</Code>
          <Description>string</Description>
        </Error>
        <Success>boolean</Success>
        <UserSchedule>
          <UserScheduleDefinition>
            <UserId>int</UserId>
            <Interval>int</Interval>
            <LastRun>dateTime</LastRun>
          </UserScheduleDefinition>
          <UserScheduleDefinition>
            <UserId>int</UserId>
            <Interval>int</Interval>
            <LastRun>dateTime</LastRun>
          </UserScheduleDefinition>
        </UserSchedule>
      </GetFullUserListResult>

Error - Code / Description

An error code and description if the call to the web service is unsuccessful and the Success if False.

...

1024 – Client authentication failed

Success

This will be either True or False. If False an error message will be provided in the Error result, if True the UserSchedule will be provided.

UserSchedule

A UserSchedule entry will be returned for each user with the following entries:

...