39

How can I convert the following JSON response to a C# object?

{ 
    "err_code": "0", 
    "org": "CGK", 
    "des": "SIN", 
    "flight_date": "20120719",
    "schedule": [
        ["W2-888","20120719","20120719","1200","1600","03h00m","737-200","0",[["K","9"],["F","9"],["L","9"],["M","9"],["N","9"],["P","9"],["C","9"],["O","9"]]],
        ["W2-999","20120719","20120719","1800","2000","01h00m","MD-83","0",[["K","9"],["L","9"],["M","9"],["N","9"]]]
    ]
}
Brian Rogers
  • 125,747
  • 31
  • 299
  • 300
Vishwajeet
  • 1,575
  • 2
  • 19
  • 35
  • if you are using an MVC there is a lot that is does out of the box to support that conversion. You can also check out this link: http://msdn.microsoft.com/en-us/library/bb410770.aspx – Glenn Ferrie Jun 29 '12 at 11:07
  • 1
    See this post: http://stackoverflow.com/questions/6620165/how-to-parse-json-in-c – Jocke Jun 29 '12 at 11:08
  • 1
    i face problem to build class for that json reponse can any one build the class for that json response – Vishwajeet Jun 29 '12 at 11:21
  • Possible duplicate of [How can I parse JSON with C#?](https://stackoverflow.com/questions/6620165/how-can-i-parse-json-with-c) – StayOnTarget Sep 19 '18 at 12:54

6 Answers6

132
  1. To create a class off a json string, copy the string.

  2. In Visual Studio, in the menu at the top, click Edit > Paste special > Paste Json as classes.

  3. Install Newtonsoft.Json via Nuget

  4. Paste the following code into your project, "jsonString" being the variable you want to deserialize :

    Rootobject r = Newtonsoft.Json.JsonConvert.DeserializeObject<Rootobject>(jsonString);

  5. Don't forget to rename Rootobject to be more descriptive eg ILoveTheSmellOfNapalmInTheMorning-that was a joke

Ole EH Dufour
  • 2,968
  • 4
  • 23
  • 48
  • 3
    Yes, I think this really what was asked for at the time. It was kind of a roundabout thing in VS2012 (see here: https://stackoverflow.com/questions/18526659/how-to-show-the-paste-json-class-in-visual-studio-2012-when-clicking-on-paste) Now in VS2017, very straightforward. – Ben Butzer Feb 16 '18 at 19:54
  • 2
    Extremely useful and when doing a conversion using JsonConvert you may have to create the delegate as an array. In my case this is what I had to do in order to convert the JSON string to a class. JsonConvert.DeserializeObject(FootnoteJSON.Value) – Brandon Jun 27 '18 at 19:55
  • 1
    I recently found the need to work with JSON and came across this site https://json2csharp.com/ and now I discover that VS does it for you. Good information to have. – Zath Jun 28 '21 at 18:39
  • 1
    This doesn't work with JSON files with size > 5 MB – Ali Hassan Nov 29 '22 at 14:48
64

First create a class to represent your json data.

public class MyFlightDto
{
    public string err_code { get; set; }
    public string org { get; set; } 
    public string flight_date { get; set; }
    // Fill the missing properties for your data
}

Using Newtonsoft JSON serializer to Deserialize a json string to it's corresponding class object.

var jsonInput = "{ org:'myOrg',des:'hello'}"; 
MyFlightDto flight = Newtonsoft.Json.JsonConvert.DeserializeObject<MyFlightDto>(jsonInput);

Or Use JavaScriptSerializer to convert it to a class(not recommended as the newtonsoft json serializer seems to perform better).

string jsonInput="have your valid json input here"; //
JavaScriptSerializer jsonSerializer = new JavaScriptSerializer();
Customer objCustomer  = jsonSerializer.Deserialize<Customer >(jsonInput)

Assuming you want to convert it to a Customer classe's instance. Your class should looks similar to the JSON structure (Properties)

Shyju
  • 214,206
  • 104
  • 411
  • 497
58

I recommend you to use JSON.NET. it is an open source library to serialize and deserialize your c# objects into json and Json objects into .net objects.

Here's some stuff from their website:

Deserialization Example:

string json = @"{
  'Name': 'Bad Boys',
  'ReleaseDate': '1995-4-7T00:00:00',
  'Genres': [
    'Action',
    'Comedy'
  ]
}";

Movie m = JsonConvert.DeserializeObject<Movie>(json);

string name = m.Name;
// Bad Boys

Performance Comparison To Other JSON serializiation Techniques enter image description here

General Grievance
  • 4,555
  • 31
  • 31
  • 45
Talha
  • 18,898
  • 8
  • 49
  • 66
  • 1
    @Vish: You should have main class e.g; FlightInfo with properties, one property should be the List of Schedule e.g; List. Schedule is the 2nd class which has also some properties. See your json string properly – Talha Jun 29 '12 at 11:39
  • @Talha:Ya but schedule contains what type of properties because in schedule there are arrays inside array – Vishwajeet Jun 29 '12 at 11:49
4

copy your Json and paste at textbox on http://json2csharp.com/ and click on Generate button,

A cs class will be generated use that cs file as below:

var generatedcsResponce = JsonConvert.DeserializeObject<RootObject>(yourJson);

where RootObject is the name of the generated cs file;

FortyTwo
  • 2,414
  • 3
  • 22
  • 33
Islam
  • 129
  • 1
  • 1
  • Great, another similar useful online tool, which might help, here it is: https://www.minify-beautify.com/json-to-csharp-class-online/ Thanks – Vikas Lalwani Aug 20 '21 at 07:40
1

This will take a json string and turn it into any class you specify

public static T ConvertJsonToClass<T>(this string json)
    {
        System.Web.Script.Serialization.JavaScriptSerializer serializer = new System.Web.Script.Serialization.JavaScriptSerializer();
        return serializer.Deserialize<T>(json);
    }
ff0000e2
  • 417
  • 7
  • 15
1
class Program
{
    static void Main(string[] args)
    {
        var res = Json; //Json that has to be converted

        Response resp = new Response();
        resp = JsonSerializer.Deserialize<Response>(res);

        Console.WriteLine(res);
    }
}

public class Response
{
    public bool isValidUser { get; set; }
    public string message { get; set; }
    public int resultKey { get; set; }
}
elena.kim
  • 930
  • 4
  • 12
  • 22