How to deserialize a JSON array into an object using Json.Net?

by

Json.Net does not have a facility to automatically map an array into a class. To do so you need a custom JsonConverter. Here is a generic converter that should work for you. It uses a custom [JsonArrayIndex] attribute to identify which properties in the class correspond to which indexes in the array. This will allow you to easily update your model if the JSON changes. Also, you can safely omit properties from your class that you don’t need, such as Filler.

Here is the code:

public class JsonArrayIndexAttribute : Attribute
{
    public int Index { get; private set; }
    public JsonArrayIndexAttribute(int index)
    {
        Index = index;
    }
}

public class ArrayToObjectConverter<T> : JsonConverter where T : class, new()
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(T);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JArray array = JArray.Load(reader);

        var propsByIndex = typeof(T).GetProperties()
            .Where(p => p.CanRead && p.CanWrite && p.GetCustomAttribute<JsonArrayIndexAttribute>() != null)
            .ToDictionary(p => p.GetCustomAttribute<JsonArrayIndexAttribute>().Index);

        JObject obj = new JObject(array
            .Select((jt, i) =>
            {
                PropertyInfo prop;
                return propsByIndex.TryGetValue(i, out prop) ? new JProperty(prop.Name, jt) : null;
            })
            .Where(jp => jp != null)
        );

        T target = new T();
        serializer.Populate(obj.CreateReader(), target);

        return target;
    }

    public override bool CanWrite
    {
        get { return false; }
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

To use the converter, you need to mark up your ChildModel class as shown below:

[JsonConverter(typeof(ArrayToObjectConverter<ChildModel>))]
class ChildModel
{
    [JsonArrayIndex(0)]
    public int ID { get; set; }
    [JsonArrayIndex(1)]
    public string StatusId { get; set; }
    [JsonArrayIndex(2)]
    public DateTime ContactDate { get; set; }
    [JsonArrayIndex(3)]
    public string State { get; set; }
    [JsonArrayIndex(4)]
    public string Status { get; set; }
    [JsonArrayIndex(5)]
    public string CustomerName { get; set; }
    [JsonArrayIndex(6)]
    public DateTime WorkStartDate { get; set; }
    [JsonArrayIndex(7)]
    public DateTime WorkEndDate { get; set; }
    [JsonArrayIndex(8)]
    public string Territory { get; set; }
    [JsonArrayIndex(9)]
    public string CustType { get; set; }
    [JsonArrayIndex(10)]
    public int JobOrder { get; set; }
    [JsonArrayIndex(12)]
    public string Link { get; set; }
}

Then just deserialize as usual and it should work as you wanted. Here is a demo: https://dotnetfiddle.net/n3oE3L

Note: I did not implement WriteJson, so if you serialize your model back to JSON, it will not serialize back to the array format; instead it will use the default object serialization.

More Related Contents:

  1. Parse JSON in C#
  2. Create a strongly typed c# object from json object with ID as the name
  3. How to deserialize an array of values with a fixed schema to a strongly typed data class?
  4. Deserializing JSON into an object
  5. JSON.Net throws StackOverflowException when using [JsonConvert()]
  6. How to parse huge JSON file as stream in Json.NET?
  7. Searching for a specific JToken by name in a JObject hierarchy
  8. Unexpected character encountered while parsing value
  9. Parsing JSON Object with variable properties into strongly typed object
  10. Order of serialized fields using JSON.NET
  11. Json.NET serialize object with root name
  12. Set default global json serializer settings
  13. Deserialize nested JSON into C# objects
  14. Serialize Property, but Do Not Deserialize Property in Json.Net
  15. Cannot deserialize the current JSON array (e.g. [1,2,3])
  16. Cannot deserialize JSON array into type – Json.NET
  17. Newtonsoft Json Deserialize Dictionary as Key/Value list from DataContractJsonSerializer
  18. Repeated serialization and deserialization creates duplicate items
  19. How do you Add or Update a JProperty Value in a JObject
  20. Modify existing object with new partial JSON data using Json.NET
  21. Accessing properties with a dot in their name
  22. json deserialize from legacy property names
  23. Load multiple concatenated JSON objects from stream
  24. Json.NET JSONPath query not returning expected results
  25. How do C# classes deal with dollar signs in JSON?
  26. How to convert c# generic list to json using json.net?
  27. JSON Deserialization – String Is Automatically Converted To Int
  28. Json.net rename properties
  29. Newtonsoft JSON for .net is ignoring jsonproperty tags
  30. How to convert JSON to XML or XML to JSON in C#?

Leave a Comment