![\"Dynamics](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2024\/11\/Dynamics-365-Field-Service.png\")
<\/p>\n<\/p>\n
For any organization using Dynamics 365 Field Service, the ability to efficiently allocate resources can make all the difference in meeting customer demands and maintaining a competitive edge. Dynamics 365 Field Service<\/a> allows us to leverage the Resource Search Availability API that revolutionizes resource allocation by providing real-time insights into resource availability. This API empowers businesses to streamline scheduling processes, optimize resource utilization, and ultimately deliver exceptional service experiences to customers.<\/p>\n With the integration of Dynamics 365 Field Service v8.8.43.51 and Universal Resource Scheduling v3.12.46.21, organizations gain access to the msdyn_SearchResourceAvailability<\/strong> API.<\/p>\n In this blog post, we’ll dive into how this API works with different programming languages like JavaScript and C#. We’ll cover what input details you need to provide and what results you can expect. By the end, you’ll have a clearer understanding of how to use this API to manage resources effectively and streamline your operations.<\/p>\n API Name<\/strong>: msdyn_SearchResourceAvailability<\/p>\n Input Parameters<\/strong>: Below are the critical input parameters necessary for using this API:<\/p>\n Imagine a situation where a user needs to schedule a booking for a specific resource. It\u2019s essential to confirm that the resource is available within the requested timeframe, ensuring efficient scheduling. If the resource is available, the booking proceeds; if not, the system restricts the user from scheduling, maintaining effective resource utilization.<\/p>\n A custom development approach can validate resource availability during the creation or update of a booking using the msdyn_SearchResourceAvailability API. If the resource is available, the system will allow the booking; otherwise, it will display a notification indicating that the resource is unavailable during the requested timeslot.<\/p>\n To use the Resource Availability API effectively, it\u2019s crucial first to configure working hours for each resource. Follow these steps:<\/p>\n Step 1: <\/strong>Go to the Resource record in CRM, open the Work Hours tab, and click New. Here, you can set the resource\u2019s working hours, time zone, and break times.<\/p>\n Step 2:<\/strong> Ensure that the defined timeslots are visible in the Calendar view.<\/p>\n With the working hours configured, the next step is to establish restrictions for booking creation if a dispatcher tries to book a resource outside available hour. This setup involves developing a plugin that will trigger when a booking is created. It checks the resource’s availability, and if the resource is unavailable, it prevents the booking from being created.<\/p>\n Below is a structured overview of the plugin code registered on the pre-validation operation for the Bookable Resource Booking entity in CRM:<\/p>\n The plugin initializes services and context objects essential for execution:<\/p>\n ITracingService logs information and traces plugin execution steps.<\/em><\/p>\n IPluginExecutionContext retrieves data on the execution context.<\/em><\/p>\n IOrganizationService allows interaction with CRM data.<\/em><\/p>\n The plugin fetches the starttime and endtime attributes from the target entity to define the timeframe for resource availability.<\/p>\n An Entity object representing the resource requirement (msdyn_resourcerequirement) is created, with attributes for date range and duration.<\/p>\n Using the helper method BuildOptionSetValueEntityCollection, the plugin specifies resource types to be considered in the availability check, added to the resource specification entity.<\/p>\n A settings entity is created to specify additional search parameters, such as including slots with proposed bookings.<\/p>\n The plugin prepares and executes an OrganizationRequest for msdyn_SearchResourceAvailability with configured settings, resource specifications, and versioning details.<\/p>\n The plugin retrieves time slot data from the response and processes each entry to convert start and end times to local time. It checks for conflicts, such as overlapping times or slots marked as unavailable.<\/p>\n This example output shows various attributes of each timeslot:<\/p>\n Example Analysis<\/strong><\/p>\n The details of each timeslot are as follows:<\/p>\n Booking Time : 11\/14\/2024 5:00:00 PM to 11\/14\/2024 5:30:00 PM<\/p>\n TimeSlots Data:<\/p>\n – TimeSlot: Start: 11\/14\/2024 2:00:00 PM, End: 11\/14\/2024 3:00:00 PM, Type: Scheduled, Potential: False, Resource: Michel Markel<\/p>\n – TimeSlot: Start: 11\/14\/2024 2:22:00 PM, End: 11\/14\/2024 2:22:00 PM, Type: Off, Potential: False, Resource: Michel Markel<\/p>\n – TimeSlot: Start: 11\/14\/2024 3:00:00 PM, End: 11\/14\/2024 3:30:00 PM, Type: Available, Potential: True, Resource: Michel Markel<\/p>\n – TimeSlot: Start: 11\/14\/2024 3:30:00 PM, End: 11\/14\/2024 4:00:00 PM, Type: Scheduled, Potential: False, Resource: Michel Markel<\/p>\n – TimeSlot: Start: 11\/14\/2024 4:00:00 PM, End: 11\/14\/2024 6:00:00 PM, Type: Available, Potential: True, Resource: Michel Markel<\/p>\n Example Booking Conflict Detection for Resource \u201cMichel Markel\u201d<\/strong><\/p>\n If the booking time overlaps with a period when the resource is unavailable due to breaks, time-off, or other bookings, the plugin throws an exception with a message indicating the conflict: \u201cConflict found: Timeslot overlaps with Booking\u2019s StartTime and EndTime, and Resource is unavailable for this time.<\/em><\/strong>\u201d Booking 1: <\/strong><\/p>\n Booking 2: <\/strong><\/p>\n Conclusion<\/strong><\/p>\n By leveraging the Resource Search Availability API in Dynamics 365 Field Service, organizations can automate resource availability validation, avoiding scheduling conflicts and optimizing resource allocation for enhanced operational efficiency.<\/p>\n For any organization using Dynamics 365 Field Service, the ability to efficiently allocate resources can make all the difference in meeting customer demands and maintaining a competitive edge. Dynamics 365 Field Service allows us to leverage the Resource Search Availability API that revolutionizes resource allocation by providing real-time insights into resource availability. This API empowers\u2026 Read More »<\/a><\/span><\/p>\n","protected":false},"author":11,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[16,2867],"tags":[2968],"class_list":["post-39716","post","type-post","status-publish","format-standard","hentry","category-dynamics-365","category-dynamics-365-field-service","tag-resource-search-availability-api-in-dynamics-365-field-service"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/39716","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/users\/11"}],"replies":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/comments?post=39716"}],"version-history":[{"count":0,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/39716\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/media?parent=39716"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/categories?post=39716"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/tags?post=39716"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
Scenario in Dynamics 365 CRM<\/strong><\/h4>\n
Preparing Resources: Setting Up Working Hours for Resources<\/strong><\/h4>\n
![\"Resource](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2024\/11\/1Resource-Search-Availability-API-in-Dynamics-365-Field-Service.png\")
<\/p>\n![\"Resource](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2024\/11\/2Resource-Search-Availability-API-in-Dynamics-365-Field-Service.png\")
<\/p>\nPlugin Code for Resource Availability Validation<\/strong><\/h4>\n
1. Initialization and Global Parameters<\/h4>\n
ITracingService tracingService = (ITracingService)serviceProvider.GetService(typeof(ITracingService));\r\n\r\nIPluginExecutionContext context = (IPluginExecutionContext)serviceProvider.GetService(typeof(IPluginExecutionContext));<\/em>\r\n\r\nIOrganizationServiceFactory serviceFactory = (IOrganizationServiceFactory)serviceProvider.GetService(typeof(IOrganizationServiceFactory));<\/em>\r\n\r\nIOrganizationService service = serviceFactory.CreateOrganizationService(context.UserId);<\/em><\/pre>\n
2. Extracting Start and End Times<\/h4>\n
DateTime StartTime = TargetEn.GetAttributeValue<DateTime>(\"starttime\");<\/em>\r\n\r\nDateTime EndTime = TargetEn.GetAttributeValue<DateTime>(\"endtime\");\r\n\r\n<\/em><\/pre>\n
3. Setting Up Resource Requirements<\/h4>\n
var requirement = new Entity(\"msdyn_resourcerequirement\");<\/em>\r\n\r\nrequirement.Attributes.Add(\"msdyn_fromdate\", fromDate);<\/em>\r\n\r\nrequirement.Attributes.Add(\"msdyn_todate\", toDate);<\/em>\r\n\r\nrequirement.Attributes.Add(\"msdyn_duration\", 60);\r\n\r\n<\/em><\/pre>\n
4. Configuring Resource Types<\/h4>\n
var resourceTypes = BuildOptionSetValueEntityCollection(\"resourcetypes\", \"value\", new List<int> { 2, 3 });<\/em>\r\n\r\nresourceSpecification.Attributes.Add(\"ResourceTypes\", resourceTypes);\r\n\r\n<\/em><\/pre>\n5. Defining Search Settings<\/h4>\n
var settings = new Entity(\"organization\");<\/em>\r\n\r\nsettings.Attributes.Add(\"ConsiderSlotsWithProposedBookings\", false);\r\n<\/em><\/pre>\n
6. Executing the Search Request<\/h4>\n
var request = new OrganizationRequest() { RequestName = \"msdyn_SearchResourceAvailability\" };<\/em>\r\n\r\nrequest[\"Version\"] = \"1\";<\/em>\r\n\r\nrequest[\"Requirement\"] = requirement;<\/em>\r\n\r\nrequest[\"IsWebApi\"] = false;<\/em>\r\n\r\nrequest[\"Settings\"] = settings;<\/em>\r\n\r\nrequest[\"ResourceSpecification\"] = resourceSpecification;<\/em>\r\n\r\nvar response = service.Execute(request);\r\n<\/em><\/pre>\n7. Parsing Available Time Slots<\/h4>\n
private static string showTimeSlotsUsingEntities(EntityCollection timeSlots, ITracingService tracingService) {<\/em>\r\n\r\n\u00a0\u00a0\u00a0 \/\/ Code to process time slots and construct the output string<\/em>\r\n\r\nIf(conflict)<\/em>\r\n\r\n{\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 throw new InvalidPluginExecutionException(\"Conflict found: Timeslot overlaps with target's StartTime and EndTime, and Potential is set to 'False'.\");<\/em>\r\n\r\n}<\/em>\r\n\r\n}\r\n\r\n<\/em><\/pre>\nThe Resource Availability API Response Structure<\/h4>\n
\n
\n
\n
\n
\n
\n
\n
\nExample Scenario <\/strong>To illustrate, we attempt to book Resource \u201cMichel Markel<\/strong>\u201d for 3:00 PM to 4:00 PM. If a second booking is attempted from 3:30 PM to 4:00 PM, a conflict message will display, preventing the booking. Below are sample screenshots showing the booking process and conflict message:<\/p>\n![\"Resource](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2024\/11\/3Resource-Search-Availability-API-in-Dynamics-365-Field-Service.png\")
<\/strong><\/p>\n![\"Resource](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2024\/11\/4Resource-Search-Availability-API-in-Dynamics-365-Field-Service.png\")
<\/strong><\/p>\n![\"\"](\"https:\/\/www.inogic.com\/blog\/wp-content\/uploads\/2023\/09\/Maplytics-A-Powerful-Tool-for-Scheduling-Tracking-and-Managing-Field-Service-1.gif\"){kind=tracking}
<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"