|
Siebel Field Service Guide > Business Service Methods Reference for Field Service > Scheduling >
GetAppointments Method
GetAppointments returns a time slot for each employee during which the employee could potentially be booked. The method reserves these time slots in memory until ConfirmAppointment or CancelRequest is called, or until the timeout elapses. Usage
This method is similar to GetAppointment, but is called specifically by Assignment Manager. GetAppointments differs from GetAppointment in the following ways:
- The actual activities being booked do not exist yet, and will not be created until ConfirmAppointment is called.
- GetAppointments checks for several employees in the same request.
- GetAppointments only returns one time slot for each employee instead of the number defined by the ABS - Default number of slots parameter. See Schedule Parameters for more information.
- GetAppointments provides the additional flag, SameTimeFlag.
- If SameTimeFlag is set to TRUE, all the employees must be scheduled together for the same time. Time slots will be returned for all or none of the specified employees.
- If SameTimeFlag is set to FALSE, the employees can each be scheduled for different times between the earliest start time and latest start time. Time slots will be returned only for only those employees that can be scheduled.
Additional Details
The inputs for this method are described in Table 145.
Table 145. Inputs for GetAppointments Method
|
|
SvcRegnId |
Service region ID of the activity. |
ReqId |
Unique number to identify this request for a subsequent call to either confirm some of the time slots returned by this function or to cancel the request and free those slots. |
EmployeeIds |
IDs of all the employees that need to be scheduled during this time. |
ActType |
Type of the activity, This could be call, appointment, administration, and so on. |
ActPriority |
Value from the Priority field of the activity; 1-ASAP, 2-High, 3- Medium, or 4-Low. |
NoSoonerThan |
Value from the Earliest Start Time field of the activity. |
NoLaterThan |
Value from the Latest Start Time field of the activity. |
Duration |
Actual length of time for which each employee is required. |
SameTimeFlag |
Flag which is used to specify whether all employees need to available at the same time or whether their appointments can be spread out at different times between the earliest and latest start time.
- TRUE indicates that the employees must be available for scheduling at the same time.
- FALSE indicates that the employees can be scheduled for different times.
|
BreakFlag |
Flag which is used to specify whether the activity can be broken into different pieces or whether it must be contiguous.
- TRUE indicates that the activity can be broken down.
- FALSE indicates that it must be contiguous.
|
This method outputs a property set containing a list of time slots, which are available for the activity. Each returned time slot contains the properties described in the following table. The outputs for this method are described in Table 146.
Table 146. Outputs for GetAppointments Method
|
|
Request Id |
Unique ID to identify the request sent to the engine. |
Assignee |
Assignee available during the time slot. |
Slot Start - SR Time Zone |
Slot start time, in activity service region time zone. |
Slot End - SR Time Zone |
Slot start time, in activity service region time zone. |
Slot Start |
Slot start time. This parameter is always in GMT time zone, not the login user's time zone. |
Slot End |
Slot end time. This parameter is always in GMT time zone, not the login user's time zone. |
Service Region Id |
Service region ID of the activity. |
Activity Id |
Activity ID of the activity being scheduled. |
|
