LINQ to DocuSign Data

This article illustrates using LINQ to access tables within the DocuSign via the CData ADO.NET Data Provider for DocuSign. To achieve this, we will use LINQ to Entity Framework, which facilitates the generation of connections and can be seamlessly employed with any CData ADO.NET Data Providers to access data through LINQ.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

1. In a new project in Visual Studio, right-click on the project and choose to add a new item. Add an ADO.NET Entity Data Model.
2. Choose EF Designer from Database and click Next.
3. Add a new Data Connection, and change your data source type to "CData DocuSign Data Source".

4. Enter your data source connection information.

   To connect to DocuSign, set the following connection properties:

   • UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
   • AccountId (optional): set it in the connection string if you have access to multiple Account Ids

   Authenticating to DocuSign

   DocuSign uses the OAuth authentication standard. To authenticate using OAuth, create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation more information.

   Below is a typical connection string:

   OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; 
   CallbackURL=http://localhost:33333;
   

👁 Required connection properties for the data source. (QuickBooks is shown.)

5. If saving your entity connection to App.Config, set an entity name. In this example we are setting DocuSignEntities as our entity connection in App.Config.
6. Enter a model name and select any tables or views you would like to include in the model.

Using the entity you created, you can now perform select commands. For example:

DocuSignEntities context = new DocuSignEntities();

var documentsQuery = from documents in context.Documents
 select documents;

foreach (var result in documentsQuery) {
 Console.WriteLine("{0} {1} ", result.Id, result.DocumentId);
}

See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.