Retrieve the Scheule information for a User

If you wish to retrieve the schedule information for a user you will need to call the GetUserSchedule method. This method is available to developers from the Users.asmx Web Service and is used to retrieve the schedule information for all users.

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

Syntax

    <GetUserScheduleResult>
        <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>
      </GetUserScheduleResult>

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

1021 – User 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:

UserId

This is the unique id for the user.

Interval

This is the interval in seconds.

LastRun

This is the date and time that My Alerts was last run for this user.