Connect REST API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Available Territory Slots
- Resource
-
/connect/scheduling/available-territory-slots - Available version
- 49.0
- HTTP methods
- POST
-
- Request example
-
{ "startTime": "2022-07-27T00:00:00.000Z", "endTime": "2022-07-29T00:00:00.000Z", "workTypeGroupId": "0VSB0000000KyjBOAS", "accountId": "001B000000qAUAWIA4", "territoryIds": [ "0HhB0000000TO9WKAW" ], "schedulingPolicyId": "0VrB0000000KyjB", "requiredResourceIds": [ "0HnB0000000TO8gKAK" ], "engagementChannelTypeIds": [ "0eFRM00000000CJ2AY" ] } - Request example with only required fields
-
{ "workType": { "id": "08qS70000004DTsIAM" }, "territoryIds": [ "0HhS70000004DTdKAM" ], "engagementChannelTypeIds": [ "0eFRM00000000CJ2AY" ] } - Properties
-
Name Type Description Required or Optional Available Version accountId String ID of the associated account. Optional 49.0 allowConcurrentScheduling Boolean Indicates whether concurrent appointments are allowed (true) or not allowed (false). The default value is false. Optional 49.0 correlationId String ID to pass custom information to the ServiceResourceScheduleHandler Apex interface. For example, you can use the correlation ID to identify the app, website, or any other external system that calls this Apex interface implementation. If you don’t pass a custom value, a randomly generated identifier is passed. Optional 53.0 endTime String Latest time that an appointment can end. Optional 49.0 engagementChannelTypeIds String[] The ID of the engagement channel type record. The resources and their associated time slots are filtered by the specified engagement channel type. You can use engagement channel types with the available-territory-slots API only if:
- Schedule Appointments Using Engagement Channels is enabled in Salesforce Scheduler Settings in your Salesforce org.
- Shifts are defined in the scheduling policy. For more information on setting up shifts in the scheduling policy, see Define Shift Rules in Scheduling Policy.
Optional 56.0 filterByResources String[] Comma-separated list of service resource IDs. API returns only eligible service resources that are both in the list and in the selected service territory. The resources are sorted by the order in which the resource IDs are passed. Optional 51.0 requiredResourceIds String[] List of resource IDs that you want to get available time slots for. When you pass more than one resource ID, the API returns all the slots where any of the passed resources are available. For example, suppose that you have three qualified resources: A, B, and C. If you pass resource IDs A and B, the API returns all the slots where:
- only A is available
- only B is available
- both A and B are available
- both A and C are available
- both B and C are available
- A, B, and C are all available
The API doesn’t return the slots where only C is available.
If this field is empty, time slots for all qualified resources are returned.
Optional 49.0 resourceLimitApptDistribution Integer Specify the maximum number of service resources that you want to show during appointment scheduling when appointment distribution is enabled. Default value is 10. Optional 53.0 schedulingPolicyId String ID of the AppointmentSchedulingPolicy object. If not provided, the default configurations are considered. Optional 49.0 startTime String Earliest time that an appointment can start. Defaults to the current time of the request, if empty. You can also use a time from the past. Optional 49.0 territoryIds String[] List of IDs of service territories where the specified work is performed. Required 49.0 workType Work Type Input Type of work performed. Required if workTypeGroupId isn’t provided 49.0 workTypeGroupId String ID of the work type group containing all work types performed. Required if workType isn’t provided 49.0
- Response example
-
{ "result": { "territorySlots": [ { "territoryId": "0HhB0000000TO9WKAW", "slots": [ { "endTime": "2019-01-23T19:15:00.000+0000", "resources": [ "0HnB0000000D2DsKAK", "0HnB0000000D2DsJKL" ], "startTime": "2019-01-23T16:15:00.000+0000" }, { "endTime": "2019-01-23T19:30:00.000+0000", "resources": [ "0HnB0000000D2DsKAK", "0HnB0000000D2DsJKL" ], "startTime": "2019-01-23T16:30:00.000+0000" } ] }, { "territoryId": "0HhB0000000TO9WERT", "slots": [ { "endTime": "2019-01-23T19:15:00.000+0000", "resources": [ "0HnB0000000D2DsKAK" ], "startTime": "2019-01-23T16:15:00.000+0000" }, { "endTime": "2019-01-23T19:30:00.000+0000", "resources": [ "0HnB0000000D2DsKAK", "0HnB0000000D2DsJKL" ], "startTime": "2019-01-23T16:30:00.000+0000" } ] } ] } }
- Response body for POST
- Available Territory Slots Output