C# JSON Connector

In this article you will learn, how to integrate JSON data to C# without coding in few clicks (Live / Bi-directional connection to JSON). JSON Connector can be used to extract and output JSON data stored in local JSON files, JSON data coming from REST API web service calls (Web URL) or direct JSON String (variables or DB columns). JSON Connector also supports JSONPath to filter data from nested array/sub-documents. This Connector is optimized to work with very large files.

Using JSON API Connector you will be able to connect, read and write data from within C#. Let's take a look at the steps below to see how exactly to accomplish that.

Download  Help File  Buy 

Create ODBC Data Source (DSN) based on ZappySys JSON Driver

To get data from Json using C# we first need to create a DSN - Data Source - which will access data from Json, which later will be able to get using C#. Perform these steps:
  1. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys JSON Driver:

    Create new JSON Driver

    You should create System DSN if client application is launched under Windows System Account, e.g. as a Windows Service.
    Launch ODBC Data Sources 32-bit version in case your client application is a 32-bit (x86) application (required only for System DSN).
  4. Select Url or File and paste the following Url for this example.
    NOTE: Here for demo, I'm using odata API, but you need to refer your own API documentation and based on that you need to use your own API URL and need to configure connection based on API Authentication type

  5. Now enter JSONPath expression in Array Filter textbox to extract only specific part of JSON file as below ($.value[*] will get content of value attribute from JSON document. Value attribute is array of JSON documents so we have to use [*] to indicate we want all records of that array)
    NOTE: Here, I'm using my desired filter, but you need to select your desired filter based on your requirement.
    Click on Test Connection button to view whether the Test Connection is SUCCESSFUL or Not.

    $.value[*]
    ZappySys ODBC Driver - Configure JSON Driver
  6. Once you configured a data source, you can preview data. Hit Preview tab, and use similar settings to preview data:
    ZappySys ODBC Driver - Preview JSON Driver

  7. Click OK to finish creating the data source

Read data in C# from the DSN

  1. Create a fresh new Console project and use this code to get the data:

    "JsonDSN"
    Make ZappySys Driver call in c#

  2. Hit F5 to run the code and read the data:
    ZappySys Driver Output in c#

  3. Here is program's code in text format:

    
        using System;
        using System.Data.Odbc;
    
        namespace ConsoleApp
        {
        class Program
        {
        static void Main()
        {
        var dsn = "JsonDSN";
    
        using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
        {
        conn.Open();
        var cmd = new OdbcCommand("SELECT * FROM Products", conn);
        var rdr = cmd.ExecuteReader();
        while (rdr.Read())
        {
        for (int i = 0; i < rdr.FieldCount; i++)
        {
        Console.Write("{0}\t", rdr[i]);
        }
        Console.WriteLine();
        }
        }
        Console.ReadKey();
        }
        }
        }
    
    

  4. If you want to avoid to be dependent on a DSN name and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String . Then in your C# code use Connection String when initializing OdbcConnection object, for example:

    
    using (var conn = new OdbcConnection("DRIVER={ZappySys API Driver};ServiceUrl=https://services.odata.org/V3/Northwind/Northwind.svc;Provider=OData;AuthName=Http;"))
    {
       // ...
    }
        
    

Create Custom Store Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Store Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Store Procedure Name

  3. Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
    @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
    AS
    SELECT * FROM Orders where OrderDate >= '<@fromdate>'

    ZappySys Driver - Create Custom Store Procedure

  4. That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01'

    ZappySys Driver - Execute Custom Store Procedure

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you dont have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
    "ShipCountry",
    "OrderID",
    "CustomerID",
    "EmployeeID",
    "OrderDate",
    "RequiredDate",
    "ShippedDate",
    "ShipVia",
    "Freight",
    "ShipName",
    "ShipAddress",
    "ShipCity",
    "ShipRegion",
    "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

Conclusion

In this article we discussed how to connect to JSON in C# and integrate data without any coding. Click here to Download JSON Connector for C# and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Documentation 

Other App Integration scenarios for JSON

Other API Connectors for C#


Documentation 

  • How to connect JSON in C#?

  • How to get JSON data in C#?

  • How to read JSON data in C#?

  • How to load JSON data in C#?

  • How to import JSON data in C#?

  • How to pull JSON data in C#?

  • How to push data to JSON in C#?

  • How to write data to JSON in C#?

  • How to POST data to JSON in C#?

  • Call JSON API in C#

  • Consume JSON API in C#

  • JSON C# Automate

  • JSON C# Integration

  • Integration JSON in C#

  • Consume real-time JSON data in C#

  • Consume realtime JSON API data in C#

  • JSON ODBC Driver | ODBC Driver for JSON | ODBC JSON Driver | SSIS JSON Source | SSIS JSON Destination

  • Connect JSON in C#

  • Load JSON in C#

  • Load JSON data in C#

  • Read JSON data in C#

  • JSON API Call in C#