GetAppointment Method
GetAppointment reserves and returns a set of employee time slots in the service region for an activity. The ConfirmAppointment or CancelAppointment method follow this method. This method has a timeout function to release reserved time slots in the event that neither of these methods are called in a timely fashion.
Invoked From
This method is called when a user clicks the Book Appointment button (in the Activities view in the Service Request List view of the Service screen and in the Schedule view in the Activity List view of the Activities screen).
Arguments
The following table describes the arguments for this method.
Argument Name | Description |
---|---|
ActId |
The activity ID of the activity to schedule. |
SvcRegnId |
The service region ID of the activity. |
Return Values
This method returns a property set containing a list of time slots that are available for the activity. The following table describes the return values that each returned time slot contains.
Return Value | Description |
---|---|
Request Id |
A unique ID to identify the request sent to the engine. |
Assignee |
The assignee available during the time slot. |
Slot Start - SR Time Zone |
The slot start time in the time zone of the service region for the activity. |
Slot End - SR Time Zone |
The slot end time in the time zone of the service region for the activity. |
Slot Start |
The slot start time. This return value is always in the GMT time zone, not the time zone for the login user. |
Slot End |
The slot end time. This return value is always in the GMT time zone, not the time zone for the login user. |
Service Region Id |
The service region ID of the activity. |
Activity Id |
The activity ID of the activity to schedule. |