How to deserialize json?

Question

0.00/5 (No votes)

See more:

Hello,
I am facing a problem with json deserialization in c# class. The Json will return by api is :-

JavaScript

{
    "fields": [
        {
            "value": "3732",
            "order": 1,
            "name": "id",
            "type": "hidden"
        },
        {
            "maxlen": "13",
            "required": "",
            "value": "0",
            "order": 2,
            "name": "job",
            "label": "Job ",
            "type": "text"
        },
        {
            "maxlen": "13",
            "required": "",
            "value": "0",
            "order": 3,
            "name": "client",
            "label": "Client ",
            "type": "text"
        },
        {
            "maxlen": "50",
            "required": "required",
            "value": "Tim Nguyen",
            "order": 4,
            "name": "task_name",
            "label": "Task Name ",
            "type": "text"
        },
        {
            "required": "required",
            "time": "05:30 PM",
            "date": "07/18/2017",
            "order": 5,
            "name": "start_date",
            "label": "Start Date ",
            "type": "datetime"
        },
        {
            "required": "",
            "time": "07:00 PM",
            "date": "07/18/2017",
            "order": 6,
            "name": "end_date",
            "label": "End Date ",
            "type": "datetime"
        },
        {
            "required": "",
            "value": "Roof Inspection",
            "order": 7,
            "name": "task_description",
            "label": "Task Description ",
            "type": "textareainput"
        }
    ],
    "action": "update_task",
    "hidden": {},
    "display": "Update Task"
}

Please help me to solve this.

Regard
Ankush

What I have tried:

C#

public class FormFillByTaskId
{
	public FieldData[] fields { get; set; }
}
public class FieldData
{
   // Don't know how to deserialize over here..
}

Posted 28-Jul-17 0:21am

Member 12385075

Updated 28-Jul-17 0:46am

Graeme_Grant

v2

Add a Solution

Comments

F-ES Sitecore 28-Jul-17 6:48am

Google "c# deserialise json" - this is very well documented, lots of examples if you just search

Graeme_Grant 28-Jul-17 6:50am

Or check out the solution below... ;)

F-ES Sitecore 28-Jul-17 6:59am

Give a man a fish....

Graeme_Grant 15-Aug-17 23:27pm

Why only a single fish when I can give a bucket full! ;)

Working with JSON in C# & VB[^]

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

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

Graeme_Grant · Accepted Answer · 2017-07-28T00:46:00

There are websites that will generate classes for you from JSON data. My favourite is: JSON Utils: Generate C#, VB.Net, SQL Table, Java and PHP from JSON[^]

Using the above JSON data, the following classes are generated:

C#

public class Field
{

    [JsonProperty("value")]
    public string Value { get; set; }

    [JsonProperty("order")]
    public int Order { get; set; }

    [JsonProperty("name")]
    public string Name { get; set; }

    [JsonProperty("type")]
    public string Type { get; set; }

    [JsonProperty("maxlen")]
    public string Maxlen { get; set; }

    [JsonProperty("required")]
    public string Required { get; set; }

    [JsonProperty("label")]
    public string Label { get; set; }

    [JsonProperty("time")]
    public string Time { get; set; }

    [JsonProperty("date")]
    public string Date { get; set; }
}

public class Hidden
{
}

public class Example
{

    [JsonProperty("fields")]
    public IList<Field> Fields { get; set; }

    [JsonProperty("action")]
    public string Action { get; set; }

    [JsonProperty("hidden")]
    public Hidden Hidden { get; set; }

    [JsonProperty("display")]
    public string Display { get; set; }
}

Next you will need to write code to convert / map the JSON data to the class structure. NuGet Gallery | Json.NET 10.0.3[^] is used by most.

Once referenced in your project, here is a helper class that I use to do the conversion from/to classes:

C#

public static class JsonConverter
{
    public static string FromClass<T>(T data, bool isEmptyToNull = false, JsonSerializerSettings jsonSettings = null)
    {
        string response = string.Empty;

        if (!EqualityComparer<T>.Default.Equals(data, default(T)))
            response = JsonConvert.SerializeObject(data, jsonSettings);

        return isEmptyToNull ? (response == "{}" ? "null" : response) : response;
    }

    public static T ToClass<T>(string data, JsonSerializerSettings jsonSettings = null)
    {
        var response = default(T);

        if (!string.IsNullOrEmpty(data))
            response = jsonSettings == null
                ? JsonConvert.DeserializeObject<T>(data)
                : JsonConvert.DeserializeObject<T>(data, jsonSettings);

        return response;
    }
}

And this is how to use the helper class:

C#

var rawJson = "{\"fields\": [{\"value\": \"3732\",\"order\": 1,\"name\": \"id\",\"type\": \"hidden\"},{\"maxlen\": \"13\",\"required\": \"\",\"value\": \"0\",\"order\": 2,\"name\": \"job\",\"label\": \"Job \",\"type\": \"text\"},{\"maxlen\": \"13\",\"required\": \"\",\"value\": \"0\",\"order\": 3,\"name\": \"client\",\"label\": \"Client \",\"type\": \"text\"},{\"maxlen\": \"50\",\"required\": \"required\",\"value\": \"Tim Nguyen\",\"order\": 4,\"name\": \"task_name\",\"label\": \"Task Name \",\"type\": \"text\"},{\"required\": \"required\",\"time\": \"05:30 PM\",\"date\": \"07/18/2017\",\"order\": 5,\"name\": \"start_date\",\"label\": \"Start Date \",\"type\": \"datetime\"},{\"required\": \"\",\"time\": \"07:00 PM\",\"date\": \"07/18/2017\",\"order\": 6,\"name\": \"end_date\",\"label\": \"End Date \",\"type\": \"datetime\"},{\"required\": \"\",\"value\": \"Roof Inspection\",\"order\": 7,\"name\": \"task_description\",\"label\": \"Task Description \",\"type\": \"textareainput\"}],\"action\": \"update_task\",\"hidden\": {},\"display\": \"Update Task\"}";
var result = JsonConverter.ToClass<Example>(rawJson);