How to convert given json into class in C#

Question

1.00/5 (1 vote)

See more:

C#4.0

JSON

WebClient

I have one API which gives different responses in reply:
For example:

API gives response:

JSON

{
    "status_id": 200,
    "status_msg": "Successful",
    "unique_trans_id": "CLIENTAPI202305260134469",
    "info": {
        "case_id": "MG.0523.30"
    }
}

Sometimes, it gives the following response:

JSON

{
    "status_id": 400,
    "status_msg": "Bad Request",
    "unique_trans_id": "CLIENTAPI202306050146459",
    "info": [
        "cp_state : value must be a valid string",
        "cp_city : value must be a valid string"
    ]
}

Sometimes, it give response:

JSON

{
    "status_id": 409,
    "status_msg": "Duplicate Request",
    "unique_trans_id": "CLIENTAPI202310270276322",
    "info": [
        "Duplicate request for reference ID I/2023/400018/00097601"
    ]
}

Following is my output class:

C#

public class OutputInfo
   {
       public string status_id { get; set; }
       public string status_msg { get; set; }
       public string unique_trans_id { get; set; }
       public infodetails info { get; set; }
   }

   public class infodetails
   {
       public string case_id { get; set; }
   }

Following is the code where I convert json into class:

C#

if (httpresponsemessage.IsSuccessStatusCode)
               {
                   var responseData =
               httpresponsemessage.Content.ReadAsStringAsync().Result;
                   strinputjson = responseData.ToString();
                   ErrorHandler.LogSteps(strinputjson, "JsonOutput");

                   tResponse =JsonConvert.DeserializeObject<TResponse>
                   (strinputjson);
               }

I want to convert json response into my OutputInfo class.

Now, the current code is giving me an error in second and third response. Kindly help me with this.

What I have tried:

I tried a lot of different code, but did not get success.

Posted 27-Oct-23 4:43am

Akshay malvankar

Updated 27-Oct-23 7:36am

Deeksha Shenoy

v2

Add a Solution

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)

Richard Deeming · Accepted Answer · 2023-10-27T05:05:00

Solution 1

This sort of API response is a nightmare to work with, but seems to be quite popular amongst the loosely-typed language crowd.

To read it in C#, you will need a custom JSON converter. For example:

C#

public class OutputInfo
{
	public string status_id { get; set; }
	public string status_msg { get; set; }
	public string unique_trans_id { get; set; }
	public InfoDetailsOrErrorList info { get; set; }
}

[JsonConverter(typeof(InfoDetailsOrErrorListConverter))]
public class InfoDetailsOrErrorList
{
	public string case_id { get; set; }
	public string[] errors { get; set; }

	public sealed class InfoDetailsOrErrorListConverter : JsonConverter<InfoDetailsOrErrorList>
	{
        public override CanWrite => false;
        
		public override InfoDetailsOrErrorList ReadJson(
            JsonReader reader, 
            Type objectType, 
            InfoDetailsOrErrorList existingValue, 
            bool hasExistingValue, 
            JsonSerializer serializer)
		{
			switch (reader.TokenType)
			{
				case JsonToken.Null:
				{
					return null;
				}
				case JsonToken.StartArray:
				{
					string[] errors = serializer.Deserialize<string[]>(reader);
					return new InfoDetailsOrErrorList { errors = errors };
				}
				case JsonToken.StartObject:
				{
					var temp = new InfoDetailsOrErrorList();
					serializer.Populate(reader, temp);
					return temp;
				}
				default:
				{
					throw new JsonException();
				}
			}
		}
		
		public override void WriteJson(
            JsonWriter writer, 
            InfoDetailsOrErrorList value, 
            JsonSerializer serializer)
		{
			throw new NotImplementedException();
		}
	}
}

Unfortunately, your consuming code will now need to check whether the info property contains an errors array (cases 2 and 3) or a case_id (case 1).

Posted 27-Oct-23 5:05am

Richard Deeming

Comments

Maciej Los 27-Oct-23 11:25am

5ed!

Graeme_Grant 27-Oct-23 19:36pm

5ed! I should add this to the growing list of examples on my articles: Working with Newtonsoft.Json in C# & VB[^] & Working with System.Text.Json in C#[^]

Akshay malvankar 28-Oct-23 10:34am

How to identify info is object or info is an array from api response

Graeme_Grant 29-Oct-23 5:14am

Look at the code given ... starting here:

switch (reader.TokenType)

Akshay malvankar 29-Oct-23 5:16am

TokenType it's given object in both response ,info property is object or info property is an array

Richard Deeming 30-Oct-23 5:04am

If it's showing as Object for both responses, then the JSON you've shown in your question is not the JSON you're trying to deserialize.

You need to debug your code to examine what the actual JSON content is.

Akshay malvankar 30-Oct-23 5:52am

As shown in above code in this line
var responseData =
httpresponsemessage.Content.ReadAsStringAsync().Result

I get above
{
"status_id": 200,
"status_msg": "Successful",
"unique_trans_id": "CLIENTAPI202305260134469",
"info": {
"case_id": "MG.0523.30"
}
}

{
"status_id": 400,
"status_msg": "Bad Request",
"unique_trans_id": "CLIENTAPI202306050146459",
"info": [
"cp_state : value must be a valid string",
"cp_city : value must be a valid string"
]
}

Richard Deeming 30-Oct-23 5:53am

If that was the JSON you were trying to parse, then you'd get a JsonTokenType.Object on the info for the 200 response, and JsonTokenType.Array on the info for the 400 response.

If that's not what you're getting, then that's not the JSON you're parsing.

Akshay malvankar 30-Oct-23 7:34am

then what it is?? if is not json ,so how i will identify from above API response ,Info is an array or an object. after this line
var responseData = httpresponsemessage.Content.ReadAsStringAsync().Result;
Please Explain in code

Richard Deeming 30-Oct-23 7:37am

How is anyone supposed to answer that? We don't have access to the API you're calling, and we can't run your code. Only you can debug your code to see what response is being returned.

As I keep saying, for all of the JSON you have shown us, you will get a JsonTokenType.Object for the info of a 200 response, and a JsonTokenType.Array for the info of a 400 response. In the parsed code, you will get a InfoDetailsOrErrorList with errors set to null for a 200 response, and a InfoDetailsOrErrorList with an array of errors for a 400 response.

You keep telling us that's "not working", but you can't seem to explain what the problem is.

So once again: YOU need to debug your code and examine the response from the API. Nobody else can do that for you.

Akshay malvankar 30-Oct-23 8:36am

I think you misunderstood my problem, read my problem again as I said in my first line I received following response from my API so there is no point for me to debug my code again I shared all thing what I received from API. My code give error from after this line "var responseData = httpresponsemessage.Content.ReadAsStringAsync().Result;"

And Here is my class
public class OutputInfo
{
public string status_id { get; set; }
public string status_msg { get; set; }
public string unique_trans_id { get; set; }
public infodetails info { get; set; }
}

public class infodetails
{
public string case_id { get; set; }
}

Again I shared for you following is my API response

API gives response:
JSON
{
"status_id": 200,
"status_msg": "Successful",
"unique_trans_id": "CLIENTAPI202305260134469",
"info": {
"case_id": "MG.0523.30"
}
}

Sometimes, it gives the following response:
JSON
{
"status_id": 400,
"status_msg": "Bad Request",
"unique_trans_id": "CLIENTAPI202306050146459",
"info": [
"cp_state : value must be a valid string",
"cp_city : value must be a valid string"
]
}

Sometimes, it give response:
JSON
{
"status_id": 409,
"status_msg": "Duplicate Request",
"unique_trans_id": "CLIENTAPI202310270276322",
"info": [
"Duplicate request for reference ID I/2023/400018/00097601"
]
}

now please help me what i should do for above response in code

if (httpresponsemessage.IsSuccessStatusCode)
{
var responseData =
httpresponsemessage.Content.ReadAsStringAsync().Result; /// After this line
strinputjson = responseData.ToString();
ErrorHandler.LogSteps(strinputjson, "JsonOutput");

tResponse =JsonConvert.DeserializeObject<tresponse>
(strinputjson);
}

now I cant explain more then this , I explain and shared all my code my problem and what I want

Richard Deeming 30-Oct-23 8:38am

So what you're saying is, you've ignored everything I put in my answer, and you're complaining that it "doesn't work".

Me posting a solution doesn't make your original code magically work. You need to use the code from my solution.