Edit

Sample: End a recurring appointment series

  • Article

This sample shows how to end a recurring appointment series by using the DeleteOpenInstancesRequest message. You can download the sample from here.

Note

This sample applies to both Dynamics 365 Customer Engagement (on-premises) and Dataverse.

How to run this sample

To obtain a local copy of all samples and build them, follow these steps:

  1. Download or clone the Samples repo so that you have a local copy.
  2. (Optional) Edit the dataverse/App.config file to define a connection string specifying the instance/organization you want to connect to.
  3. Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in dataverse/App.config, any sample you run will use that connection information.

If you don't specify a connection string in dataverse/App.config file, a dialog opens each time you run the sample, and you'll need to enter information about which instance or org you want to connect to and which credentials you want to use. This dialog caches previous connections so that you can choose a previously used connection.

What this sample does

The DeleteOpenInstanceRequest message is intended to be used in a scenario where it contains the data that is needed to delete instances of a recurring appointment master that has an Open state.

How this sample works

In order to simulate the scenario described in What this sample does, the sample will do the following:

Setup

  1. Checks for the current version of the org.
  2. Defines the anonymous types that define possible recurrence pattern values, possible values for days, and recurrence rule pattern end type values.
  3. Creates a new recurring appointment that is required for the sample.

Demonstrate

  1. The RecurringAppointmentMaster message retrieves a recurring appointment series that is created in the Setup.
  2. The DeleteOpenInstanceRequest message ends the recurring appointment series to the last occurring past instance date w.r.t. the series end date.

Clean up

Display an option to delete the sample data created in Setup. The deletion is optional in case you want to examine the entities and data created by the sample. You can manually delete the records to achieve the same result.