Click here to Skip to main content
14,495,410 members

How to Get REST Data and Display it in a DataGridView (or not) using JSON.NET

Rate this:
4.72 (6 votes)
Please Sign up or sign in to vote.
4.72 (6 votes)
1 Oct 2014CPOL
Get REST data and display it in a DataGridView

Get Some Rest

This tip is related to this one, which shows how to easily call a REST method that returns a scalar value.

In this case, I will show how you can almost as easily retrieve an array of complex data from a REST call and display the results in a DataGridView.

Notable: The current DataGridView is not your unavuncular uncle's DataGridView - it is very smart and can make sense out of almost anything you assign to it!

So, drag-and-drop or plop a DataGridView control onto a Windows Form. To use the code below (you'll have to provide your own URI), retain the default name of "dataGridView1".

The Big Fig / Descendant of Isaac?

As this code uses JSON.NET's JsonConvert() method and the JArray type, use NuGet to add Newtonsoft's JSON.NET to your project; NuGet auto-adds newtonsoft.json to your project's References. You just need to install Json.NET via NuGet, and then add two using clauses, namely: "using Newtonsoft.Json" and "using Newtonsoft.Json.Linq". 

Workable Solution

All it takes to retrieve the results and populate a DataGridView is code like so:

private void GetRESTData(string uri)
        var webRequest = (HttpWebRequest)WebRequest.Create(uri);
        var webResponse = (HttpWebResponse)webRequest.GetResponse();
        if ((webResponse.StatusCode == HttpStatusCode.OK) && (webResponse.ContentLength > 0))
            var reader = new StreamReader(webResponse.GetResponseStream());
            string s = reader.ReadToEnd();
            var arr = JsonConvert.DeserializeObject<JArray>(s);
            dataGridView1.DataSource = arr;
            MessageBox.Show(string.Format("Status code == {0}", webResponse.StatusCode));
    catch (Exception ex)

...and call it like so:


More Elegant than Lauren Bacall and Joan Fontaine in their Heyday

If you're serious about SOLID, particularly the "S" part (Single Responsibility Principle), you may be turning red or have gone green at the gills, and have steam pouring out your ears to boot as you noticed that the GetRESTData() method does two things: it retrieves the data from the REST method AND it then populates the DataGridView!

What if you want to do something else with the returned value - you'd have to write another method -- or, you could refactor this one because of that problem. So, okay, I give in, we'll refactor it. Here's the new code, which returns the results (in a JArray type) and allows the caller to do what they will with said data:

private JArray GetRESTData(string uri)
    var webRequest = (HttpWebRequest)WebRequest.Create(uri);
    var webResponse = (HttpWebResponse)webRequest.GetResponse();
    var reader = new StreamReader(webResponse.GetResponseStream());
    string s = reader.ReadToEnd();
    return JsonConvert.DeserializeObject<JArray>(s);

So, as it should be, GetRESTData() now knows nothing about any DataGridView, and it only does one thing (and does it well, I might add). And here's how we can now call the new and improved GetRESTData() method:

    dataGridView1.DataSource = GetRESTData("http://localhost:28642/api/inventoryitems/1/10");
catch (WebException webex)
    MessageBox.Show("Es gab so ein Schlamassel! ({0})", webex.Message);

Now that it has been solidified and made safer for reuse, you can call GetRESTData() and do something else with the returned data: parse it, slice it, dice it, or decrypt it and sell it all to the NSA, NASA, or PITA -- or even sprinkle it with oregano and garlic and have it on Pita bread. Happy now?

The Wisdom of the Crowd

Thanks to Matthew, who provided an even better take on my original refactor here.

Rational Exuberance and Random Generosity

If you like this tip, go outside, do a somersault, summerset, salto, or salto de gozo and/or click your heels like Zorba the Greco-Roman Architect, and give $5 to the hungriest-looking person you see.


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


About the Author

B. Clay Shannon
Founder Across Time & Space
United States United States
I am in the process of morphing from a software developer into a portrayer of Mark Twain. My monologue (or one-man play, entitled "The Adventures of Mark Twain: As Told By Himself" and set in 1896) features Twain giving an overview of his life up till then. The performance includes the relating of interesting experiences and humorous anecdotes from Twain's boyhood and youth, his time as a riverboat pilot, his wild and woolly adventures in the Territory of Nevada and California, and experiences as a writer and world traveler, including recollections of meetings with many of the famous and powerful of the 19th century - royalty, business magnates, fellow authors, as well as intimate glimpses into his home life (his parents, siblings, wife, and children).

Peripatetic and picaresque, I have lived in eight states; specifically, besides my native California (where I was born and where I now again reside) in chronological order: New York, Montana, Alaska, Oklahoma, Wisconsin, Idaho, and Missouri.

I am also a writer of both fiction (for which I use a nom de plume, "Blackbird Crow Raven", as a nod to my Native American heritage - I am "½ Cowboy, ½ Indian") and nonfiction, including a two-volume social and cultural history of the U.S. which covers important events from 1620-2006:

Comments and Discussions

QuestionRead from file Pin
floris van den hoeven2-Apr-14 3:07
Memberfloris van den hoeven2-Apr-14 3:07 
AnswerRe: Read from file Pin
B. Clay Shannon2-Apr-14 5:17
professionalB. Clay Shannon2-Apr-14 5:17 
QuestionSomehow I missed this when you posted it Pin
Garth J Lancaster17-Jan-14 11:58
professionalGarth J Lancaster17-Jan-14 11:58 
AnswerRe: Somehow I missed this when you posted it Pin
B. Clay Shannon17-Jan-14 12:10
professionalB. Clay Shannon17-Jan-14 12:10 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Posted 17 Jan 2014


18 bookmarked