Get Appointment Candidates

Get a list of service resources based on the work type group or work type, and service territory that are selected in the previous step. A service resource represents an employee from your organization, such as a loan officer, investment advisor, doctor, nurse practitioner, or retail store specialist, who attends appointments with clients.

Create a page in your app where you can show the available service resources based on the work type group or work type, and service territory.

Make a POST request on the getAppointmentCandidates REST API by passing the required workTypeGroupId or workTypeId, and territoryIds parameters.

Resource URI

1https://yourInstance.salesforce.com/services/data/vXX.X/scheduling/getAppointmentCandidates

For an Existing User (Account)

To consider an existing user’s preferred visiting hours, pass accountId in the input request body. The preference is enforced when the Include Only Required Service Resources and Ignore Excluded Service Resources policy rules are enabled.

Sample Request

Using workTypeGroupId:

1{
2   "accountId" : "001B000001McLhMIAV",
3   "startTime" : "2021-10-29T08:00:00.000+0000",
4   "endTime" : "2021-10-29T18:00:00.000+0000",
5   "allowConcurrentScheduling" : true,
6   "workTypeGroupId" : "0VSB0000000TbhWOAS",
7   "territoryIds" : ["0HhB00000001P0PKAU"]
8}

Using workTypeId:

1{
2   "accountId" : "001B000001McLhMIAV",
3   "startTime" : "2021-10-29T08:00:00.000+0000",
4   "endTime" : "2021-10-29T18:00:00.000+0000",
5   "allowConcurrentScheduling" : true,
6   "workType" : {
7                 "id" : "08qB00000002ocgIAA"
8   },
9   "territoryIds" : ["0HhB00000001P0PKAU"]
10}

Sample Response

The API returns the available time slots and service resources.

1{
2  "candidates" : [ {
3    "endTime" : "2021-10-29T16:00:00.000+0000",
4    "resources" : [ "0HnB00000001SJxKAM" ],
5    "startTime" : "2021-10-29T15:00:00.000+0000",
6    "territoryId" : "0HhB00000001P0PKAU"
7  }, {
8    "endTime" : "2021-10-29T16:30:00.000+0000",
9    "resources" : [ "0HnB00000001SJxKAM" ],
10    "startTime" : "2021-10-29T15:30:00.000+0000",
11    "territoryId" : "0HhB00000001P0PKAU"
12  }, {
13    "endTime" : "2021-10-29T17:00:00.000+0000",
14    "resources" : [ "0HnB00000001SJxKAM" ],
15    "startTime" : "2021-10-29T16:00:00.000+0000",
16    "territoryId" : "0HhB00000001P0PKAU"
17  }, {
18    "endTime" : "2021-10-29T17:30:00.000+0000",
19    "resources" : [ "0HnB00000001SJxKAM" ],
20    "startTime" : "2021-10-29T16:30:00.000+0000",
21    "territoryId" : "0HhB00000001P0PKAU"
22  }, {
23    "endTime" : "2021-10-29T18:00:00.000+0000",
24    "resources" : [ "0HnB00000001SJxKAM" ],
25    "startTime" : "2021-10-29T17:00:00.000+0000",
26    "territoryId" : "0HhB00000001P0PKAU"
27  }, {
28    "endTime" : "2021-10-29T16:00:00.000+0000",
29    "resources" : [ "0HnB00000001SOUKA2" ],
30    "startTime" : "2021-10-29T15:00:00.000+0000",
31    "territoryId" : "0HhB00000001P0PKAU"
32  }, {
33    "endTime" : "2021-10-29T16:30:00.000+0000",
34    "resources" : [ "0HnB00000001SOUKA2" ],
35    "startTime" : "2021-10-29T15:30:00.000+0000",
36    "territoryId" : "0HhB00000001P0PKAU"
37  }, {
38    "endTime" : "2021-10-29T17:00:00.000+0000",
39    "resources" : [ "0HnB00000001SOUKA2" ],
40    "startTime" : "2021-10-29T16:00:00.000+0000",
41    "territoryId" : "0HhB00000001P0PKAU"
42  }, {
43    "endTime" : "2021-10-29T17:30:00.000+0000",
44    "resources" : [ "0HnB00000001SOUKA2" ],
45    "startTime" : "2021-10-29T16:30:00.000+0000",
46    "territoryId" : "0HhB00000001P0PKAU"
47  }, {
48    "endTime" : "2021-10-29T18:00:00.000+0000",
49    "resources" : [ "0HnB00000001SOUKA2" ],
50    "startTime" : "2021-10-29T17:00:00.000+0000",
51    "territoryId" : "0HhB00000001P0PKAU"
52  } ]
53}

For a Guest User (Lead)

Sample Request

Using workTypeGroupId:

1{
2   "startTime" : "2021-10-13T08:00:00.000+0000",
3   "endTime" : "2021-10-13T18:00:00.000+0000",
4   "allowConcurrentScheduling" : true,
5   "workTypeGroupId" : "0VSB0000000TbhWOAS",
6   "territoryIds" : ["0HhB00000001P0PKAU"],
7}

Using workTypeId:

1{
2   "accountId" : "001B000001McLhMIAV",
3   "startTime" : "2021-10-29T08:00:00.000+0000",
4   "endTime" : "2021-10-29T18:00:00.000+0000",
5   "allowConcurrentScheduling" : true,
6   "workType" : {
7                 "id" : "08qB00000002ocgIAA"
8   },
9   "territoryIds" : ["0HhB00000001P0PKAU"]
10}

Sample Response

The API returns the available time slots and service resources.

1{
2  "candidates" : [ {
3    "endTime" : "2021-10-29T16:00:00.000+0000",
4    "resources" : [ "0HnB00000001SJxKAM" ],
5    "startTime" : "2021-10-29T15:00:00.000+0000",
6    "territoryId" : "0HhB00000001P0PKAU"
7  }, {
8    "endTime" : "2021-10-29T16:30:00.000+0000",
9    "resources" : [ "0HnB00000001SJxKAM" ],
10    "startTime" : "2021-10-29T15:30:00.000+0000",
11    "territoryId" : "0HhB00000001P0PKAU"
12  }, {
13    "endTime" : "2021-10-29T17:00:00.000+0000",
14    "resources" : [ "0HnB00000001SJxKAM" ],
15    "startTime" : "2021-10-29T16:00:00.000+0000",
16    "territoryId" : "0HhB00000001P0PKAU"
17  }, {
18    "endTime" : "2021-10-29T17:30:00.000+0000",
19    "resources" : [ "0HnB00000001SJxKAM" ],
20    "startTime" : "2021-10-29T16:30:00.000+0000",
21    "territoryId" : "0HhB00000001P0PKAU"
22  }, {
23    "endTime" : "2021-10-29T18:00:00.000+0000",
24    "resources" : [ "0HnB00000001SJxKAM" ],
25    "startTime" : "2021-10-29T17:00:00.000+0000",
26    "territoryId" : "0HhB00000001P0PKAU"
27  }, {
28    "endTime" : "2021-10-29T16:00:00.000+0000",
29    "resources" : [ "0HnB00000001SOUKA2" ],
30    "startTime" : "2021-10-29T15:00:00.000+0000",
31    "territoryId" : "0HhB00000001P0PKAU"
32  }, {
33    "endTime" : "2021-10-29T16:30:00.000+0000",
34    "resources" : [ "0HnB00000001SOUKA2" ],
35    "startTime" : "2021-10-29T15:30:00.000+0000",
36    "territoryId" : "0HhB00000001P0PKAU"
37  }, {
38    "endTime" : "2021-10-29T17:00:00.000+0000",
39    "resources" : [ "0HnB00000001SOUKA2" ],
40    "startTime" : "2021-10-29T16:00:00.000+0000",
41    "territoryId" : "0HhB00000001P0PKAU"
42  }, {
43    "endTime" : "2021-10-29T17:30:00.000+0000",
44    "resources" : [ "0HnB00000001SOUKA2" ],
45    "startTime" : "2021-10-29T16:30:00.000+0000",
46    "territoryId" : "0HhB00000001P0PKAU"
47  }, {
48    "endTime" : "2021-10-29T18:00:00.000+0000",
49    "resources" : [ "0HnB00000001SOUKA2" ],
50    "startTime" : "2021-10-29T17:00:00.000+0000",
51    "territoryId" : "0HhB00000001P0PKAU"
52  } ]
53}

Parse the JSON response, and show the available resources on the page so that the user can select a resource for the appointment.

Here’s how a page showing the available service resources can look.

A representation of the Select Service Resource screen.

When users select a resource, show the available time slots for the selected resource. Here’s how a page showing the available time slots can look.

A representation of the Select Service Appointment Time screen.

On the next page in your app, you can show the appointment details for the user to review and create the appointment.