How to deserialize a property with a dash (“-”) in its name with NewtonSoft JsonConvert?

Question

We have a JSON object with one of the object having a dash in its name. Ex below.

{
    "veg": [
        {
            "id": "3",
            "name": "Vegetables",
            "count": "25"
        },
        {
            "id": "4",
            "name": "Dal",
            "count": "2"
        },
        {
            "id": "5",
            "name": "Rice",
            "count": "8"
        },
        {
            "id": "7",
            "name": "Breads",
            "count": "6"
        },
        {
            "id": "9",
            "name": "Meals",
            "count": "3"
        },
        {
            "id": "46",
            "name": "Extras",
            "count": "10"
        }
    ],
    "non-veg": [
        {
            "id": "25",
            "name": "Starters",
            "count": "9"
        },
        {
            "id": "30",
            "name": "Gravies",
            "count": "13"
        },
        {
            "id": "50",
            "name": "Rice",
            "count": "4"
        }
    ]
}

How can we deserialize this json?

Not a duplicate. This question seeks to solve a specific and distinct problem. One that I had, by the way, so I'm kind of invested in this. — MrBoJangles, Aug 11 '15 at 16:14

score 99 · Answer 1 · answered Nov 28 '15 at 22:40

99

To answer the question on how to do this WITH NewtonSoft, you would use the JsonProperty property attribute flag.

[JsonProperty(PropertyName="non-veg")]
public string nonVeg { get; set; }

answered Nov 28 '15 at 22:40

Jerry

4,507
9
50
79

4

For VB use: – George Filippakos Mar 22 '16 at 05:27

score 27 · Accepted Answer · answered Feb 07 '13 at 14:18

You can achieve this by using DataContractJsonSerializer

[DataContract]
public class Item
{
    [DataMember(Name = "id")]
    public int Id { get; set; }
    [DataMember(Name = "name")]
    public string Name { get; set; }
    [DataMember(Name = "count")]
    public int Count { get; set; }
}

[DataContract]
public class ItemCollection
{
    [DataMember(Name = "veg")]
    public IEnumerable<Item> Vegetables { get; set; }
    [DataMember(Name = "non-veg")]
    public IEnumerable<Item> NonVegetables { get; set; }
}

now you can deserialize it with something like this:

string data;

// fill the json in data variable

ItemCollection collection;
using (MemoryStream ms = new MemoryStream(Encoding.Unicode.GetBytes(data)))
{
    DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(ItemCollection));
    collection = (ItemCollection)serializer.ReadObject(ms);
}

Can I define `DataMember` only for the property containing the dash and leave the rest as it is? — Abdullah Saleem, Mar 23 '15 at 18:47
You need to add DataMember to every property you want to be serialized, however you may not specify the name if the name of the property is good enough. — Vasil Trifonov, Apr 22 '15 at 15:25

score 1 · Answer 3 · answered Apr 20 '23 at 21:18

1

Based on Jerry's answer you can do it this way using System.Text.Json.Serialization:

[JsonPropertyName("non-veg")]
public string nonVeg { get; set; }

answered Apr 20 '23 at 21:18

Iván Sainz

409
6
12

score 0 · Answer 4 · answered Oct 11 '22 at 23:37

0

You can use JObject.Parse (included in newtonsoft) to grab any properties even if they have special characters.

JObject result = JObject.Parse(json);
Console.WriteLine(result["non-veg"][0]["name"].ToString());

answered Oct 11 '22 at 23:37

Wes

1,847
1
16
30

How to deserialize a property with a dash (“-”) in its name with NewtonSoft JsonConvert?

4 Answers4

Linked

Related