Get Slots (POST)

Get slots associated with the provider or asset.

Resource 

1/connect/health/appointment-management/slots

Resource Example 

Replace {yourInstance} with the My Domain name of your Salesforce org.

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

HTTP Methods 

POST

Request Body for POST 

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

Request Parameters for POST 

Parameter NameTypeDescriptionRequired or OptionalAvailable version
appointment​TypesArrayType of the appointment. An array of strings. Required, if none of the following are provided:
  • workTypeId
  • serviceTypes
  • serviceCategories
Required65.0
channel​IdStringEngagement channel associated with the work type.Required65.0
endDateStringEnd date and time for the slots range.Required65.0
resourcesResources InputArray of resources, like provider or device.Required65.0
service​CategoriesArrayList of broad categorizations of the service. An array of strings. Required, if none of the following are provided:
  • workTypeId
  • serviceTypes
  • appointmentType
Required65.0
service​TypesArrayList of specific services to be performed. An array of strings. Required, if none of the following are provided:
  • workTypeId
  • appointmentType
  • serviceCategories
Required65.0
source​SystemStringSource system associated with the appointment type, service type or service category. Required, if workTypeId is not provided but either appointmentType, serviceTypes, or serviceCategories is.Required65.0
start​DateStringStart date and time for the slots range.Required65.0
workType​IdStringWork type associated with the resource.Required65.0

Response Body for POST 

Get Slots Output