ServiceAppointmentRequestInfo Class

Represents the list of parameters that are passed to the ServiceResourceScheduleHandler interface. This class is implemented internally by Apex.

Namespace

LxScheduler

ServiceAppointmentRequestInfo Constructors

The following are constructors for ServiceAppointmentRequestInfo.

ServiceAppointmentRequestInfo(startDate, endDate, ServiceResources, SchedulingPolicyId, workTypeGroupId, accountId, primaryResourceId, workTypeId, correlationId)

Creates a new instance of the lxscheduler.ServiceAppointmentRequestInfo class using the specified start date, end date, service resources, scheduling policy, work type group, accound ID, primary resource, work type, and correlation.

Signature

public ServiceAppointmentRequestInfo(Datetime startDate, Datetime endDate, List<lxscheduler.ServiceResourceInfo> ServiceResources, String SchedulingPolicyId, String workTypeGroupId, String accountId, String primaryResourceId, String workTypeId, String correlationId)

Parameters

startDate
Type: Datetime
The start date and time for which unavailable time slots are requested.
endDate
Type: Datetime
The end date and time for which unavailable time slots are requested.
ServiceResources
Type: List<lxscheduler.ServiceResourceInfo>
The list of requested service resources for the unavailable time slots.
SchedulingPolicyId
Type: String
The ID of the scheduling policy .
workTypeGroupId
Type: String
The work type group ID.
accountId
Type: String
The account ID of an existing user.
primaryResourceId
Type: String
The ID of the primary service resource.
workTypeId
Type: String
The work type ID.
correlationId
Type: String
A unique identifier for a service appointment request.

ServiceAppointmentRequestInfo Methods

The following are methods for ServiceAppointmentRequestInfo.

getAccountId()

Returns the account ID of the customer if the API request contains one.

Signature

public String getAccountId()

Return Value

Type: String

getCorrelationId()

Returns a unique identifier for a request.

Signature

public String getCorrelationId()

Return Value

Type: String

getEndDate()

Returns the end date and time for which unavailable time slots are requested.

Signature

public Datetime getEndDate()

Return Value

Type: Datetime

getPrimaryResourceId()

Returns the ID of the primary service resource.

Signature

public String getPrimaryResourceId()

Return Value

Type: String

getSchedulingPolicyId()

Returns the ID of the scheduling policy that the API request contains.

Signature

public String getSchedulingPolicyId()

Return Value

Type: String

getServiceResources()

Returns the list of requested service resources for the unavailable time slots.

Signature

public List<lxscheduler.ServiceResourceInfo> getServiceResources()

Return Value

Type: List<lxscheduler.ServiceResourceInfo>

getStartDate()

Returns the start date and time for which unavailable time slots are requested.

Signature

public Datetime getStartDate()

Return Value

Type: Datetime

getWorkTypeGroupId()

Returns the work type group ID if the API request contains one.

Signature

public String getWorkTypeGroupId()

Return Value

Type: String

getWorkTypeId()

Returns the work type ID if the API request contains one.

Signature

public String getWorkTypeId()

Return Value

Type: String