Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Get Slots (POST)

Get slots associated with the provider or asset.

Resource

1/connect/health/appointment-management/slots

Resource Example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/health/appointment-management/slots

HTTP methods

POST

Request body for POST

1
2                                {
3  "resources": [
4    {
5      "resourceId": "c51xx000000B1xxBCI",
6      "serviceTerritoryId": "08pxx000000G6xxGHG",
7      "serviceResourceId": "08pxx000000I8xxIKM",
8      "resourceType": "Provider"
9    }
10  ],
11  "channelId": "a02xx000000A8xxAGH",
12  "workTypeId": "1Fwxx0000004C9bCAE",
13  "startDate": "2013-12-10T09:00:00Z",
14  "endDate": "2013-12-10T11:00:00Z",
15  "sourceSystem": "<cerner>",
16  "appointmentTypes": [
17    "FOLLOW-UP"
18  ],
19  "serviceCategories": [
20    "serviceCategoryCode1",
21    "serviceCategoryCode2" 
22
23  ],
24  "serviceTypes": [
25    "serviceTypeCode1",
26    "serviceTypeCode2"
27  ]
28}
29

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available version
`appointmentTypes`	Array	Type of the appointment. An array of strings. Required, if none of the following are provided: `workTypeId` `serviceTypes` `serviceCategories`	Required	65.0
`channelId`	String	Engagement channel associated with the work type.	Required	65.0
`endDate`	String	End date and time for the slots range.	Required	65.0
`resources`	Resources Input	Array of resources, like provider or device.	Required	65.0
`serviceCategories`	Array	List of broad categorizations of the service. An array of strings. Required, if none of the following are provided: `workTypeId` `serviceTypes` `appointmentType`	Required	65.0
`serviceTypes`	Array	List of specific services to be performed. An array of strings. Required, if none of the following are provided: `workTypeId` `appointmentType` `serviceCategories`	Required	65.0
`sourceSystem`	String	Source system associated with the appointment type, service type or service category. Required, if `workTypeId` is not provided but either `appointmentType`, `serviceTypes`, or `serviceCategories` is.	Required	65.0
`startDate`	String	Start date and time for the slots range.	Required	65.0
`workTypeId`	String	Work type associated with the resource.	Required	65.0

Response body for POST

Get Slots Output

Agentforce Health Developer Guide

Get Slots (POST)