DEVDOCS-1186/DEVDOCS-1178

eg-03-csharp-auth-code-grant-core/Controllers/Eg015EnvelopeTabDataController.cs

@@ -0,0 +1,57 @@
+using DocuSign.eSign.Api;
+using DocuSign.eSign.Client;
+using DocuSign.eSign.Model;
+using eg_03_csharp_auth_code_grant_core.Models;
+using Microsoft.AspNetCore.Mvc;
+using Newtonsoft.Json;
+
+namespace eg_03_csharp_auth_code_grant_core.Controllers
+{
+    [Route("eg015")]
+    public class Eg015EnvelopeTabDataController : EgController
+    {
+        public Eg015EnvelopeTabDataController(DSConfiguration config, IRequestItemsService requestItemsService) 
+            : base(config, requestItemsService)
+        {
+            ViewBag.title = "Get Envelope Tab Information";
+        }
+        public override string EgName => "eg015";
+
+        [HttpPost]
+        public IActionResult Create()
+        {
+            // Check the token with minimal buffer time.
+            bool tokenOk = CheckToken(3);
+            if (!tokenOk)
+            {
+                // We could store the parameters of the requested operation 
+                // so it could be restarted automatically.
+                // But since it should be rare to have a token issue here,
+                // we'll make the user re-enter the form data after 
+                // authentication.
+                RequestItemsService.EgName = EgName;
+                return Redirect("/ds/mustAuthenticate");
+            }
+
+            var basePath = RequestItemsService.Session.BasePath + "/restapi";
+
+            // Step 1: Obtain your OAuth token
+            var accessToken = RequestItemsService.User.AccessToken; //represents your {ACCESS_TOKEN}
+            var accountId = RequestItemsService.Session.AccountId; //represents your {ACCOUNT_ID}
+            var envelopeId = RequestItemsService.EnvelopeId;
+
+            // Step 2: Construct your API headers
+            var config = new Configuration(new ApiClient(basePath));
+            config.AddDefaultHeader("Authorization", "Bearer " + accessToken);
+
+            // Step 3: Call the eSignature REST API
+            EnvelopesApi envelopesApi = new EnvelopesApi(config);
+            EnvelopeFormData results = envelopesApi.GetFormData(accountId, envelopeId);
+
+            ViewBag.h1 = "Get envelope tab data information";
+            ViewBag.message = "Results from the Envelopes::get method:";
+            ViewBag.Locals.Json = JsonConvert.SerializeObject(results, Formatting.Indented);
+            return View("example_done");
+        }
+    }
+}

eg-03-csharp-auth-code-grant-core/Controllers/Eg019AccessCodeAuthController.cs

@@ -3,8 +3,8 @@
 using DocuSign.eSign.Api;
 using DocuSign.eSign.Model;
 using eg_03_csharp_auth_code_grant_core.Models;
-using System.Text;
 using Microsoft.AspNetCore.Mvc;
+using System.Text;
 using DocuSign.eSign.Client;
 
 namespace eg_03_csharp_auth_code_grant_core.Controllers
@@ -20,7 +20,6 @@ public Eg019AccessCodeAuthController(DSConfiguration config, IRequestItemsServic
 
         public override string EgName => "eg019";
 
-
         [HttpPost]
         public IActionResult Create(string signerEmail, string signerName, string accessCode)
         {
@@ -37,14 +36,12 @@ public IActionResult Create(string signerEmail, string signerName, string access
 
             // Data for this method:
             // signerEmail 
-            // signerName
-
+            // signerName            
             var basePath = RequestItemsService.Session.BasePath + "/restapi";
-            var recipientId = Guid.NewGuid().ToString();
 
             // Step 1: Obtain your OAuth token
-            var accessToken = RequestItemsService.User.AccessToken;
-            var accountId = RequestItemsService.Session.AccountId;
+            var accessToken = RequestItemsService.User.AccessToken; //represents your {ACCESS_TOKEN}
+            var accountId = RequestItemsService.Session.AccountId; //represents your {ACCOUNT_ID}
 
             // Step 2: Construct your API headers
             var config = new Configuration(new ApiClient(basePath));
@@ -80,7 +77,7 @@ public IActionResult Create(string signerEmail, string signerName, string access
                 DocumentId = "1",
                 // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems.
                 // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis.
-                RecipientId = recipientId
+                RecipientId = "1" //represents your {RECIPIENT_ID}
             };
 
             // Tabs are set per recipient/signer
@@ -96,12 +93,11 @@ public IActionResult Create(string signerEmail, string signerName, string access
                 RoutingOrder = "1",
                 Status = "Created",
                 DeliveryMethod = "Email",
-                RecipientId = recipientId,
-                AccessCode = accessCode,
+                RecipientId = "1", //represents your {RECIPIENT_ID}
+                AccessCode = accessCode, //represents your {ACCESS_CODE}
                 Tabs = signer1Tabs
             };
 
-
             Recipients recipients = new Recipients();
             recipients.Signers = new List<Signer> { signer1 };
             env.Recipients = recipients;

eg-03-csharp-auth-code-grant-core/Controllers/Eg023IdvAuthController.cs

@@ -12,17 +12,16 @@ namespace eg_03_csharp_auth_code_grant_core.Controllers
     [Route("eg023")]
     public class Eg023IdvAuthController : EgController
     {
-        public Eg023IdvAuthController(DSConfiguration config, IRequestItemsService requestItemsService) 
+        public Eg023IdvAuthController(DSConfiguration config, IRequestItemsService requestItemsService)
             : base(config, requestItemsService)
         {
             ViewBag.title = "ID Verification Authentication";
         }
 
         public override string EgName => "eg023";
 
-
         [HttpPost]
-        public IActionResult Create(string signerEmail, string signerName)
+        public IActionResult Create(string signerEmail, string signerName, string ccEmail, string ccName)
         {
             // Check the token with minimal buffer time.
             bool tokenOk = CheckToken(3);
@@ -35,27 +34,23 @@ public IActionResult Create(string signerEmail, string signerName)
                 return Redirect("/ds/mustAuthenticate");
             }
 
-
-            // Data for this method:
+            // Data for this method
             // signerEmail 
             // signerName
             var basePath = RequestItemsService.Session.BasePath + "/restapi";
-            var recipientId = Guid.NewGuid().ToString();
-
 
             // Step 1: Obtain your OAuth token
-            var accessToken = RequestItemsService.User.AccessToken;
-            var accountId = RequestItemsService.Session.AccountId;
+            var accessToken = RequestItemsService.User.AccessToken; //represents your {ACCESS_TOKEN}
+            var accountId = RequestItemsService.Session.AccountId; //represents your {ACCOUNT_ID}
 
             // Step 2: Construct your API headers
             var config = new Configuration(new ApiClient(basePath));
             config.AddDefaultHeader("Authorization", "Bearer " + accessToken);
 
-
-            //Step 3: Retreive the WorkflowId
+            //Step 3: Retreive the workflow ID
             AccountsApi workflowDetails = new AccountsApi(config);
             AccountIdentityVerificationResponse wfRes = workflowDetails.GetAccountIdentityVerification(accountId);
-            Console.WriteLine("Workflow id: " + wfRes.IdentityVerification[0].WorkflowId);
+            Console.WriteLine("Workflow ID: " + wfRes.IdentityVerification[0].WorkflowId);
 
             // Step 4: Construct your envelope JSON body
             // Note: If you did not successfully obtain your workflow ID, step 4 will fail.
@@ -88,9 +83,8 @@ public IActionResult Create(string signerEmail, string signerName)
                 DocumentId = "1",
                 // A 1- to 8-digit integer or 32-character GUID to match recipient IDs on your own systems.
                 // This value is referenced in the Tabs element below to assign tabs on a per-recipient basis.
-                RecipientId = recipientId
-        };
-
+                RecipientId = "1" //represents your {RECIPIENT_ID}
+            };
 
             // Tabs are set per recipient/signer
             Tabs signer1Tabs = new Tabs
@@ -111,7 +105,7 @@ public IActionResult Create(string signerEmail, string signerName)
                 Note = "",
                 Status = "created",
                 DeliveryMethod = "email",
-                RecipientId = recipientId,
+                RecipientId = "1", //represents your {RECIPIENT_ID}
                 IdentityVerification = workflow,
                 Tabs = signer1Tabs
             };
@@ -124,7 +118,6 @@ public IActionResult Create(string signerEmail, string signerName)
             EnvelopesApi envelopesApi = new EnvelopesApi(config);
             EnvelopeSummary results = envelopesApi.CreateEnvelope(accountId, env);
 
-
             ViewBag.h1 = "Envelope sent";
             ViewBag.message = "The envelope has been created and sent!<br />Envelope ID " + results.EnvelopeId + ".";
             return View("example_done");

eg-03-csharp-auth-code-grant-core/Views/Eg015EnvelopeTabData/eg015.cshtml

@@ -0,0 +1,44 @@
+<h4>15. Get the tab data from an envelope</h4>
+<p>Get the tab (field) values from an envelope for all of the envelope's recipients.</p>
+
+<p>
+    This method is used to read the updated tab values from
+    the envelope. The method can be used after the envelope is complete or while it is
+    still in progress.
+</p>
+
+@if (ViewBag.showDoc) {
+<p><a target='_blank' href='@ViewBag.documentation'>Documentation</a> about this example.</p>
+}
+
+
+<p>
+    API method used:
+    <a target='_blank' href="https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeFormData/get">EnvelopeFormData::get</a>.
+</p>
+
+<p>
+    View source file <a target="_blank" href="@ViewBag.source">Eg015EnvelopeTabDataController.cs</a> on GitHub.
+</p>
+
+@if (ViewBag.envelopeOk) {
+<p>
+    The last envelope you created with this example launcher will be queried.
+    Recommendation:  use example 9, then this example, since example 9 includes many tabs of different types.
+</p>
+
+<form class="eg" action="" method="post" data-busy="form">
+    <input type="hidden" name="_csrf" value="<%- csrfToken %>">
+    <button type="submit" class="btn btn-primary">Continue</button>
+</form>
+} else {
+<p>
+    Problem: please first create an envelope using <a href="eg009">example 9.</a> <br />
+    Thank you.
+</p>
+
+<form class="eg" action="eg009" method="get">
+    <button type="submit" class="btn btn-primary">Continue</button>
+</form>
+
+}

eg-03-csharp-auth-code-grant-core/Views/Eg019AccessCodeAuth/eg019.cshtml

@@ -28,7 +28,7 @@
     <div class="form-group">
         <label for="accessCode">Access Code</label>
         <input type="text" class="form-control" id="accessCode" name="accessCode"
-               aria-describedby="acText" placeholder="Rnter a recipient access code here" required>
+               aria-describedby="acText" placeholder="Enter a recipient access code here" required>
         <small id="acText" class="form-text text-muted">Provide this string to a recipient that is different such as in person or by mail or via different email.</small>
     </div>
     <div class="form-group">

eg-03-csharp-auth-code-grant-core/Views/Home/Index.cshtml

@@ -171,9 +171,11 @@
     </p>
 
     <h2>Tabs Examples</h2>
-    <h4 id="example015">15. <a href="#">Get the tab data from an envelope</a></h4>
-    <p>Comming Soon...</p>
+    <h4 id="example015">15. <a href="eg015">Get the tab data from an envelope</a></h4>
+    <p>This example retrieves the <strong>tab</strong> (<a target="_blank" href="https://developers.docusign.com/esign-rest-api/guides/concepts/tabs">field</a>) values from an envelope.</p>
     <p>
+        API method used:
+        <a target='_blank' href="https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeFormData/get">EnvelopeFormData::get</a>.
     </p>
 
     <h4 id="example016">16. <a href="#">Set tab values for a envelope</a></h4>