Bookshelf v8.0: GetAppointment Method

GetAppointment reserves and returns a set of employee time slots in the service region for a given activity. This method is followed by ConfirmAppointment or CancelAppointment. This method has a timeout function to release reserved time slots in the event that neither of these are called in a timely fashion.

Usage

This method is called when the user clicks the Book Appointment button on the Service screen > Service Request List > Activities view and the Activities screen > Activity List > Schedule view.

Additional Details

Table 153. Inputs for GetAppointment Method
Input	Description
ActId	Activity ID of the activity which needs to be scheduled.
SvcRegnId	Service region ID of the activity.

This method outputs a property set containing a list of time slots that are available for the activity. Each returned time slot contains the properties described in Table 154.

Table 154. Outputs for GetAppointment Method
Output	Description
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, in client time zone. 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.