Field Service Developer Guide

Field Service Developer Guide
Get Ready to Develop with Field Service
API End-of-Life
Field Service Data Objects
Field Service REST API
Field Service Metadata API
Field Service Tooling API
Field Service Apex Namespace
FSL Apex Namespace
AdvancedGapMatrix Class
AppointmentBookingService Class
AppointmentBookingSlot Class
GradeSlotsService Class
GradeSlotsService Constructors
GradeSlotsService Methods
OAAS Class
OAASRequest Class
PolygonUtils Class
ResourceScheduleData Class
ScheduleResult Class
ScheduleService Class
SchedulingOption Class
TimeInterval Class
Field Service Custom Triggers
Field Service Code Examples
Field Service Mobile App
PDF

Newer Version Available

This content describes an older version of this product. View Latest

GradeSlotsService Class

Represents the results shown in the Candidates quick action. Use the GradeSlotsService class to evaluate all possible slots where a given service appointment can be scheduled.

Namespace

FSL

Usage

When scheduling a service appointment, the user scheduling the appointment must have one of four managed package permission sets: Field Service Admin, Field Service Dispatcher, Field Service Agent, Self-Service. If you’re using platform events to schedule appointments, you must explicitly configure the user so that the user has the correct permissions. Without the proper configuration, the platform event runs as the Automated Process system user and doesn’t have the correct permissions to schedule an appointment. To learn more, see Configure the User and Batch Size for Your Platform Event Trigger.

Note

GradeSlotsService Constructors

The following are constructors for GradeSlotsService.

GradeSlotsService(schedulingPolicyId, serviceAppointmentId)

Creates a new instance of the GradeSlotsService class using the specified scheduling policy ID and service appointment ID.

Signature

public GradeSlotsService(Id schedulingPolicyId, Id serviceAppointmentId)

Parameters

schedulingPolicyId
Type: Id
The record ID of the scheduling policy being used to schedule the service appointment.
serviceAppointmentId
Type: Id
The record ID of the service appointment being scheduled.

GradeSlotsService Methods

GradeSlotsService includes the following static method.

getGradedMatrix(i_ResultsInUserTimeZone)

Returns a matrix of resource IDs and graded time slots. The information is similar to that shown in the Candidates quick action.

Signature

public FSL.AdvancedGapMatrix getGradedMatrix(Boolean i_ResultsInUserTimeZone)

Parameters

i_ResultsInUserTimeZone
Type: Boolean

If true, all DateTimes are returned in the user’s time zone. If false, all DateTimes are returned in UTC.

Return Value

Type: FSL.AdvancedGapMatrix

Usage

If Enhanced Scheduling and Optimization (ESO) is enabled, this method runs synchronously. If ESO isn’t enabled, this method can be called with only one service appointment at a time, and runs asynchronously. To examine results that the asynchronous method returns, use the streaming API and subscribe to MstCompletedChannel, the channel for the Field Service managed package.

Example

This example illustrates how to parse the results in the FSL.AdvancedGapMatrix to extract the service resource ID, start and end times, and grade of each slot.