Merge pull request MicrosoftDocs#3229 from MicrosoftDocs/pehecke-webapi-sample-update

Updated topic with latest changes to the sample

Author: phecke

powerapps-docs/developer/common-data-service/webapi/samples/functions-actions-csharp.md

@@ -2,7 +2,7 @@
 title: "Web API Functions and Actions Sample (C#) (Common Data Service)| Microsoft Docs"
 description: "This sample demonstrates how to call bound and unbound functions and actions, including custom actions, using the Common Data Service Web API and C#"
 ms.custom: ""
-ms.date: 1/09/2019
+ms.date: 8/06/2020
 ms.service: powerapps
 ms.suite: ""
 ms.tgt_pltfrm: ""
@@ -49,12 +49,14 @@ Go to [Web API Functions and Actions Sample (C#)](https://github.com/Microsoft/P
 |WebAPIFunctionsandActions_1_0_0_0_managed.zip|A custom managed solution containing two custom actions called by this sample.|  
 
 Next, use the following procedure to run this sample.  
+
+1. Using Dynamics 365 Customer Engagement (**Settings** > **Solutions**) or Power Apps (**Solutions**), import the provided solution (.zip) file into your testing environment.
 
 1. Locate and double-click on the solution file, FunctionsAndActions.sln, to load the solution into Visual Studio. Build the **FunctionsAndActions** solution.  This should automatically download and install all the required NuGet packages that are either missing or need to be updated.  
 
-2. Edit the application configuration file, App.config, to specify connection information for your Common Data Service server.  
+1. Edit the application configuration file, App.config, to specify connection information for your Common Data Service server.  
 
-3. Run the **FunctionsAndActions** project from within Visual Studio.  All sample solutions are configured to run in debug mode by default.  
+1. Build and run the **FunctionsAndActions** project from within Visual Studio.  All sample solutions are configured to run in debug mode by default.  
 
 <a name="bkmk_codeListing"></a>
 
@@ -63,8 +65,7 @@ Next, use the following procedure to run this sample.
  `SampleProgram.cs`  
 
 ```csharp  
-  
-using Newtonsoft.Json.Linq;
+using Newtonsoft.Json.Linq;
 using System;
 using System.Collections.Generic;
 using System.Configuration;
@@ -78,6 +79,13 @@ using System.Threading.Tasks;
 namespace PowerApps.Samples
 
 {
+    // TODO The reader must load the provided sample solution into the target testing environment
+    // Otherwise, the custom action code in this program will not work.
+
+    /// <summary>
+    /// Demonstrates Web API functions and actions.
+    /// </summary>
+    /// <seealso cref="https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/webapi/samples/functions-actions-csharp"/>
     public partial class SampleProgram
     {
         static void Main(string[] args)
@@ -94,9 +102,10 @@ namespace PowerApps.Samples
                     "v9.0"))
                 {
                     CreateRequiredRecords(client);
-                    //DeleteRequiredRecords(client, prompt);
+
                     HttpRequestMessage request;
                     HttpResponseMessage response;
+
                     #region Call an unbound function with no parameters.
                     //Retrieve the current user's full name from the WhoAmI function:
                     // https://msdn.microsoft.com/library/mt607925.aspx, which returns a WhoAmIResponse 
@@ -111,6 +120,8 @@ namespace PowerApps.Samples
                         throw new Exception(string.Format("Failed to retrieve current user", response.Content));
                     }
                     JObject whoAmIresp = JObject.Parse(response.Content.ReadAsStringAsync().Result);
+                    response.Dispose();
+
                     //First obtain the user's ID.
                     myUserId = (Guid)whoAmIresp["UserId"];
                     //Then retrieve the full name for that unique ID.
@@ -128,6 +139,8 @@ namespace PowerApps.Samples
                         Console.WriteLine("Error calling WhoAmI!");
                         throw new Exception(string.Format("Failed to retrieve the fullname for that unique ID", response.Content));
                     }
+                    response.Dispose();
+
                     Console.WriteLine("\tCurrent user has system name '{0}'.", currentUser);
                     #endregion Call an unbound function with no parameters.
 
@@ -161,6 +174,8 @@ namespace PowerApps.Samples
                         throw new Exception(string.Format("Faile calling GetTimeZoneCodeByLocalizedName!", response.Content));
 
                     }
+                    response.Dispose();
+
                     timeZoneCode = LocalizedNameResponse["TimeZoneCode"].ToString();
                     Console.WriteLine("\tThe time zone '{0}' has the code '{1}'.", timeZoneName, timeZoneCode);
                     #endregion Call an unbound function that requires parameters.
@@ -185,6 +200,8 @@ namespace PowerApps.Samples
                         Console.WriteLine("Error calling CalculateTotalTimeIncident!");
                         throw new Exception(string.Format("Failed calling CalculateTotalTimeIncident!", response.Content));
                     }
+                    response.Dispose();
+
                     Console.WriteLine("\tThe total duration of tasks associated with the incident " +
                         "is {0} minutes.", totalTime);
                     #endregion Call a bound function.  
@@ -214,19 +231,22 @@ namespace PowerApps.Samples
                         Console.WriteLine("Error calling WinOpportunity!");
                         throw new Exception(string.Format("Failed to close an opportunity as won", response.Content));
                     }
+                    response.Dispose();
+
                     Console.WriteLine("\tOpportunity won.");
                     #endregion Call an unbound action that requires parameters.
 
                     #region Call a bound action that requires parameters.
                     //Add a new letter tracking activity to the current user's queue. Uses the AddToQueue 
                     //action: https://msdn.microsoft.com/library/mt607880.aspx, which is bound to the queue 
                     //entity type: https://msdn.microsoft.com/library/mt607886.aspx, and returns a 
-                    //AddToQueueResponse complex type: https://msdn.microsoft.com/library/mt608105.aspx.
+                    //AddToQueueResponse complex type: https://msdn.microsoft.com/en-us/library/mt608105.aspx.
                     string queueItemId;
                     //Create a letter tracking instance.
                     string letterUri;
                     JObject letter = new JObject();
-                    letter["description"] = "Example letter";
+                    letter["subject"] = "Example letter";
+                    letter["description"] = "Body of the letter";
                     Console.WriteLine("Bound action: AddToQueue");
                     request = new HttpRequestMessage(HttpMethod.Post, client.BaseAddress + "letters");
                     request.Content = new StringContent(letter.ToString(), Encoding.UTF8, "application/json");
@@ -242,10 +262,11 @@ namespace PowerApps.Samples
                         Console.WriteLine("Error creating tracking letter!");
                         throw new Exception(string.Format("Failed to create a Letter", response.Content));
                     }
+                    response.Dispose();
 
                     //Retrieve the ID associated with this new letter tracking activity.
                     string letterActivityId;
-                    response = client.GetAsync(letterUri + "?$select=activityid",
+                    response = client.GetAsync(letterUri + "?$select=activityid,subject",
                         HttpCompletionOption.ResponseHeadersRead).Result;
                     if (response.IsSuccessStatusCode)
                     {
@@ -257,6 +278,7 @@ namespace PowerApps.Samples
                         Console.WriteLine("Error retrieving tracking letter activity ID!");
                         throw new Exception(string.Format("Failed to retrieve trscking letter activity ID", response.Content));
                     }
+                    response.Dispose();
 
                     //Retrieve URL to current user's queue.
                     string myQueueUri;
@@ -272,13 +294,14 @@ namespace PowerApps.Samples
                         Console.WriteLine("Error retrieving current user queue URL!");
                         throw new Exception(string.Format("Failed to retrieve URL to current user's queue", response.Content));
                     }
+                    response.Dispose();
 
                     //Add letter activity to current user's queue, then return its queue ID.
                     JObject addToQueueParams = new JObject();
                     addToQueueParams["Target"] = JObject.Parse(
                       @"{activityid: '" + letterActivityId + @"', '@odata.type': 'Microsoft.Dynamics.CRM.letter' }");
                     request = new HttpRequestMessage(HttpMethod.Post, myQueueUri + "/Microsoft.Dynamics.CRM.AddToQueue");
-                    request.Content = new StringContent(addToQueueParams.ToString());
+                    request.Content = new StringContent(addToQueueParams.ToString(), Encoding.UTF8, "application/json");
                     response = client.SendAsync(request, HttpCompletionOption.ResponseHeadersRead).Result;
                     if (response.StatusCode == HttpStatusCode.OK)
                     {
@@ -290,76 +313,11 @@ namespace PowerApps.Samples
                         Console.WriteLine("Error adding letter activity to queue!");
                         throw new Exception(string.Format("Failed to Add letter activity to current user's queue", response.Content));
                     }
+                    response.Dispose();
+
                     Console.WriteLine("\tQueueItemId returned from AddToQueue action: {0}", queueItemId);
                     #endregion Call a bound action that requires parameters.
 
-                    //Attempt to load the associated managed solution so that we can call its custom actions. 
-                    //Check first if the solution is already installed by retrieving its ID.
-                    customSolutionID = customSolutionName;
-                    bool install = true;
-                    //Request to install and solution is not already present
-                    if (install == true && customSolutionID == null)
-                    {
-                        //Locate the custom solution zip file, which should have been copied over to the build 
-                        //output directory.
-                        string solutionPath = Directory.GetCurrentDirectory() + "\\" + customSolutionFilename;
-                        if (!File.Exists(solutionPath))
-                        { return; }
-                        //Read the solution package into memory
-                        byte[] packageBytes = File.ReadAllBytes(solutionPath);
-                        //Import the solution package.
-                        JObject importParams = new JObject();
-                        importParams["CustomizationFile"] = packageBytes;
-                        importParams["OverwriteUnmanagedCustomizations"] = false;
-                        importParams["PublishWorkflows"] = false;
-                        importParams["ImportJobId"] = Guid.NewGuid();
-
-                        request = new HttpRequestMessage(HttpMethod.Post, "ImportSolution");
-                        request.Content = new StringContent(importParams.ToString(), Encoding.UTF8, "application/json");
-                        response = client.SendAsync(request, HttpCompletionOption.ResponseContentRead).Result;
-                        if (response.IsSuccessStatusCode)
-                        {
-                            customSolutionID = customSolutionName;
-                            string solutionUri = client.BaseAddress.ToString() + "solutions(" + customSolutionID + ")";
-                            entityUris.Add(solutionUri);  //Add to lifetime-managed records.
-                            return;
-                        }
-                        else
-                        { throw new Exception(string.Format("Failed to import solution package", response.Content)); }
-                    }
-                    //Request to uninstall and solution is present. 
-                    else if (install == false && customSolutionID != null)
-                    {
-                        string solutionUri = client.BaseAddress.ToString() + "solutions(" + customSolutionID + ")";
-                        response = client.DeleteAsync(solutionUri).Result;
-                        customSolutionID = null;
-                    }
-                    if (customSolutionID == null)
-                    {
-                        Console.WriteLine("Failed to install custom solution, so custom operations cannot be called.");
-                        return;
-                    }
-
-                    string solutionID = null;
-
-                    if (String.IsNullOrEmpty(solutionName))
-                    { //return null;
-                    }
-                    string queryOptions = "solutions?$select=solutionid&$filter=uniquename eq '" + solutionName + "'";
-                    response = client.GetAsync(queryOptions, HttpCompletionOption.ResponseHeadersRead).Result;
-                    if (response.StatusCode == HttpStatusCode.OK)
-                    {
-                        JObject solutionArray = JObject.Parse(response.Content.ReadAsStringAsync().Result);
-                        //There can only be zero or one returned record when filtering on a unique property.
-                        if (!solutionArray["value"].Any())
-                        { solutionID = null; }
-                        else
-                        { solutionID = solutionArray["value"].First()["solutionid"].ToString(); }
-                    }
-                    else
-                    { throw new Exception(string.Format("Failed to get  solutionID", response.Content)); }
-                    ///return solutionID;
-
                     #region Call a bound custom action that requires parameters.
                     //Add a note to a specified contact. Uses the custom action sample_AddNoteToContact, which
                     //is bound to the contact to annotate, and takes a single param, the note to add. It also  
@@ -379,9 +337,11 @@ namespace PowerApps.Samples
                     }
                     else
                     {
-                        Console.WriteLine("Error calling custom action sample_AddNoteToContact!");
+                        Console.WriteLine("Error calling custom action AddNoteToContact!");
                         throw new Exception(string.Format("Failed calling custom action sample_AddNoteToContact", response.Content));
                     }
+                    response.Dispose();
+
                     Console.WriteLine("\tA note with the title '{0}' was created and " +
                         "associated with the contact {2}.",
                         note1["NoteTitle"], note1["NoteText"],
@@ -404,6 +364,8 @@ namespace PowerApps.Samples
                         Console.WriteLine("Error calling custom action sample_CreateCustomer!");
                         throw new Exception(string.Format("Failed calling custom action sample_CreateCustomer", response.Content));
                     }
+                    response.Dispose();
+
                     Console.WriteLine("\tThe account '" + customerName1 + "' was created.");
 
                     //Try to call the same custom action with invalid parameters, here the same name is
@@ -420,6 +382,7 @@ namespace PowerApps.Samples
                         Exception ex = new Exception(string.Format("Failed calling custom action", response.Content));
                         Console.WriteLine("\tExpected Error: " + ex.Message);
                     }
+                    response.Dispose();
                     #endregion Call an unbound custom action that requires parameters.
 
                     DeleteRequiredRecords(client, prompt);
@@ -438,7 +401,6 @@ namespace PowerApps.Samples
         }
     }
 }
-
 ```  
 
 ### See also