How to Deserialize JSON with numerical keys using Json.NET

Question

How to Deserialize JSON with numerical keys using Json.NET

Is there a way to convert the provided JSON data into an object using Json.NET? The issue I am facing is that the class name must start with a number.

One example of such a scenario is when using the Wikipedia article API. By making a request through the API endpoint, you receive a JSON response similar to the one below. Take note of the value "16689396" within the "pages" section.


{
   "batchcomplete":"",
   "continue":{
      "grncontinue":"0.893378504602|0.893378998188|35714269|0",
      "continue":"grncontinue||"
   },
   "query":{
      "pages":{
         "16689396":{
            "pageid":16689396,
            "ns":0,
            "title":"Jalan Juru",
            "extract":"<p><b>Jalan Juru</b> (Penang state road <i>P176</i>) is a major road in Penang, Malaysia.</p>\n\n<h2><span id=\"List_of_junctions\">List of junctions</span></h2>\n<p></p>\n<p><br></p>"
         }
      }
   }
}

What is the solution for deserializing this JSON data which includes a dynamic number linked to the article?

c#json json.net

Answer 1

Answer №1

If you need to update the Pages property in your Query class, consider using either a Dictionary<int, Page> or Dictionary<string, Page>.

Below is an example implementation based on the provided JSON data - certain names have been assumed for clarity:

// Imports
using System;
using System.Collections.Generic;
using System.IO;
using Newtonsoft.Json;

// Classes
public class Root
{
    [JsonProperty("batchcomplete")]
    public string BatchComplete { get; set; }
    [JsonProperty("continue")]
    public Continuation Continuation { get; set; }
    [JsonProperty("query")]
    public Query Query { get; set; }
}

public class Continuation
{
    [JsonProperty("grncontinue")]
    public string GrnContinue { get; set; }
    [JsonProperty("continue")]
    public string Continue { get; set; }
}

public class Query
{
    [JsonProperty("pages")]
    public Dictionary<int, Page> Pages { get; set; }
}

public class Page
{
    [JsonProperty("pageid")]
    public int Id { get; set; }
    [JsonProperty("ns")]
    public int Ns { get; set; }
    [JsonProperty("title")]
    public string Title { get; set; }
    [JsonProperty("extract")]
    public string Extract { get; set; }
}

// Main Test Class
class Test
{
    static void Main()
    {
        // Read JSON file
        string text = File.ReadAllText("test.json");

        // Deserialize JSON to object
        var root = JsonConvert.DeserializeObject<Root>(text);

        // Output specific page title 
        Console.WriteLine(root.Query.Pages[16689396].Title);
    }    
}

Answer 2

If you need to update the Pages property in your Query class, consider using either a Dictionary<int, Page> or Dictionary<string, Page>.

Below is an example implementation based on the provided JSON data - certain names have been assumed for clarity:

// Imports
using System;
using System.Collections.Generic;
using System.IO;
using Newtonsoft.Json;

// Classes
public class Root
{
    [JsonProperty("batchcomplete")]
    public string BatchComplete { get; set; }
    [JsonProperty("continue")]
    public Continuation Continuation { get; set; }
    [JsonProperty("query")]
    public Query Query { get; set; }
}

public class Continuation
{
    [JsonProperty("grncontinue")]
    public string GrnContinue { get; set; }
    [JsonProperty("continue")]
    public string Continue { get; set; }
}

public class Query
{
    [JsonProperty("pages")]
    public Dictionary<int, Page> Pages { get; set; }
}

public class Page
{
    [JsonProperty("pageid")]
    public int Id { get; set; }
    [JsonProperty("ns")]
    public int Ns { get; set; }
    [JsonProperty("title")]
    public string Title { get; set; }
    [JsonProperty("extract")]
    public string Extract { get; set; }
}

// Main Test Class
class Test
{
    static void Main()
    {
        // Read JSON file
        string text = File.ReadAllText("test.json");

        // Deserialize JSON to object
        var root = JsonConvert.DeserializeObject<Root>(text);

        // Output specific page title 
        Console.WriteLine(root.Query.Pages[16689396].Title);
    }    
}

Answer 3

Answer №2

Check out this related question about deserializing JSON from wikipedia API using C#

To make the necessary changes, you'll want to switch from using a class for the pages to a dictionary. This allows for a more dynamic approach to handling naming conventions.

Here are the class definitions:

public class PageValue
{
    public int PageId { get; set; }
    public int Namespace { get; set; }
    public string Title { get; set; }
    public string Extract { get; set; }
}

public class Query
{
    public Dictionary<string, PageValue> Pages { get; set; }
}

public class Limits
{
    public int Extracts { get; set; }
}

public class RootObject
{
    public string BatchComplete { get; set; }
    public Query Query { get; set; }
    public Limits Limits { get; set; }
}

For deserialization, use the following code snippet:

var root = JsonConvert.DeserializeObject<RootObject>(__YOUR_JSON_HERE__);
var page = responseJson.Query.Pages["16689396"];

Answer 4

Check out this related question about deserializing JSON from wikipedia API using C#

To make the necessary changes, you'll want to switch from using a class for the pages to a dictionary. This allows for a more dynamic approach to handling naming conventions.

Here are the class definitions:

public class PageValue
{
    public int PageId { get; set; }
    public int Namespace { get; set; }
    public string Title { get; set; }
    public string Extract { get; set; }
}

public class Query
{
    public Dictionary<string, PageValue> Pages { get; set; }
}

public class Limits
{
    public int Extracts { get; set; }
}

public class RootObject
{
    public string BatchComplete { get; set; }
    public Query Query { get; set; }
    public Limits Limits { get; set; }
}

For deserialization, use the following code snippet:

var root = JsonConvert.DeserializeObject<RootObject>(__YOUR_JSON_HERE__);
var page = responseJson.Query.Pages["16689396"];

Answer 5

Answer №3

If you want to customize the way JSON is deserialized, you have the option of creating your own Deserializer or modifying the JSON data prior to deserialization.

Answer 6

If you want to customize the way JSON is deserialized, you have the option of creating your own Deserializer or modifying the JSON data prior to deserialization.

How to Deserialize JSON with numerical keys using Json.NET

Answer №1

Answer №2

Answer №3

Similar questions

Ways to emphasize a particular <li> element?

Fetching weather data from the Darksky.com API in JSON format

Steps for converting an HTML form into a sophisticated JavaScript object

Manipulating web elements by traversing through selected identifiers in LocalStorage and eliminating them from the document layout

Swift - Transforming an NSMutableArray into an array of MKAnotationViews

Passing a JavaScript variable to PHP resulted in the output being displayed as "Array"

What is the method for retrieving a PHP JSON variable value and displaying it in HTML?

Information released by JavaScript through AJAX and JSON

Steps to prevent inputting an entire JSON object into a sole field in AWS Athena

Exploring the extraction of dual values from a deeply nested JSON string using Jackson

Azure Function: Eliminate duplicate data in JSON from two many-to-many relationships into a single table

I incorporated JSON into my codeigniter project as follows

How to effectively utilize the Twitter API with C# - a comprehensive guide

Receiving NullReferenceException when attempting to access Firefox logs with Selenium in c#

Using JSON data in a Flask template

What is the best way to handle parsing a JSON object in a single response?

Converting JSON data into a dataframe yields varying numerical values

Looking at and adding to JSON files in Python

Using the Onedrive API in Python for data manipulation

JavaScript code encounters difficulties parsing HTML source