--- schema_version: "1" id: f2bd6fdb9a693a7ac268ff7c70e3573f0185988d2aba7d7638c37f76547747df title: Get Resources for Manual Scheduling Action collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/actions_obj_get_resources_manual_scheduling.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_get_resources_manual_scheduling.htm source_site: developer.salesforce.com content_type: documentation content_hash: 74464c872e15604769cb1be02a4ea334c4a488f7bb18ec22b283bc552838a078 description: Recommend resources to use when you manually schedule a start of care visit or recurring visits. --- # Get Resources for Manual Scheduling Action Recommend resources to use when you manually schedule a start of care visit or recurring visits. This action is available in API version 61.0 and later. ## Special Access Rules The Get Resources for Manual Scheduling action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting. ## Supported REST HTTP Methods **URI**: /services/data/vXX.X/actions/standard/getResourcesForMnlScheduling Where XX.X is the latest API version. **Formats**: JSON, XML **HTTP Methods**: GET **Authentication**: Authorization: Bearer TOKEN Where TOKEN is your OAuth access token. ## Inputs
Input Type Description
operatingHoursId String ID of the operating hours record that specifies the time slots to schedule a home visit.
recurringDaysList List <String> Comma-delimited list of days to schedule recurring home visits. For example, Monday, Thursday, and Saturday. If recurrenceFrequencyType parameter is set to Weekly, the recurringDaysList parameter is required.
recurrenceFrequencyCount Integer

Number of recurring home visits to be scheduled Weekly or Daily, based on the value specified in the recurrenceFrequencyType parameter.

When recurrenceFrequencyType parameter value is Weekly, the recurrenceFrequencyCount parameter value specifies the number of home visits to schedule per week. When recurrenceFrequencyType parameter value is Daily, the recurrenceFrequencyCount parameter value specifies the number of home visits to schedule per day.

recurrenceFrequencyType String Required

Type of recurring home visits. Valid values are:

  • Daily
  • Weekly

If the value is set to Weekly, the recurringDaysList parameter is required.

resourceRecommendationCount Integer Required

Maximum number of resource recommendations to be shown to the scheduler.
schedulingPolicyId String Required

ID of the home health scheduling policy to be used to identify care resources available for the home visits.
serviceAppointmentId String Required

ID of a service appointment record that’s used to get the eligible resources for the home visits.
visitsRequired Integer Required

Number of recurring home visits to schedule.
visitType String Required

Type of home visit to fetch the resources for. Valid values are:

  • Start of Care
  • Recurring
workTypeId String ID of the work type record used to get the resources for the home visit.
## Outputs
Output Type Description
endDateTime Datetime Scheduled end for the returned slot.
grade Integer Grade for the resource recommendation.
manualSchedulingRecommendations JSON JSON collection of the resourceRecommendations parameter that contains resource details such as resource name, resource ID, and their available time intervals.
recommendationGrade Integer Grade for the resource and slot combination.
resourceId String ID of the selected service resource.
resourceName String Name of the selected service resource.
resourceRecommendations JSON JSON collection for each resource that contains resource details such as resource name, resource ID, their available time slots, and the grade for the resource recommendation.
sequence Integer Sequence of this interval in the returned list of resources.
startDateTime Datetime Scheduled start for the returned slot.
scheduleIntervalRecommendations JSON JSON that contains time interval details for the recommended resource. The details include start date, end date, grade for the time slot, and the sequence number in which the service appointment gets scheduled.
visitType String

Type of home visit to fetch the resources for. Valid values are:

  • Start of Care
  • Recurring
## Example **GET** This sample request is for the Get Resources for Manual Scheduling action. { "inputs": \[ { "visitType": "Recurring", "schedulingPolicyId": "a0cSGxx0000CD37YAG", "workTypeId": "08qSG0000004zBNYxx", "recurrenceFrequencyType": "WEEKLY", "recurrenceFrequencyCount": 2, "visitsRequired": 2, "recurringDaysList": "Monday,Tuesday", "resourceRecommendationCount": 3, "operatingHoursId": "0OHSG00000xxSUH4A4", "serviceAppointmentId": "08pSG00000xxUrdYAG" } \] } This sample response is for the Get Resources for Manual Scheduling action. { { "visitType": "Recurring", "manualSchedulingRecommendations": \[ { "resourceRecommendations": \[ { "scheduleIntervalRecommendations": \[ { "startDateTime": "2024-08-05T12:59:59.000Z", "sequence": 1, "grade": "100", "endDateTime": "2024-08-05T01:00:00.000Z" }, { "startDateTime": "2024-08-06T05:15:00.000Z", "sequence": 2, "grade": "0", "endDateTime": "2024-08-06T02:00:00.000Z" } \], "resourceName": "Allen Smith", "resourceId": "0HnSG00000085yb0xx" } \], "recommendationGrade": "85" } \] } }