Get Service Resources

Retrieve the available service resources based on the selected work type group or work type, and service territory.

A service resource is 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.

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

   Resource URI

   Where YOUR_INSTANCE is a variable.

   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:

   Using workTypeId:

   Sample Response

   The API returns the service resources and their available time slots.

   For a Guest User (Lead)

   Sample Request

   Using workTypeGroupId:

   Using workTypeId:

   Sample Response

   The API returns the service resources and their available time slots.

Parse the JSON response, and display the available service resources on web page so that users can select a service resource for the appointment. Here’s how that page can look.

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.

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