-143

I'm using a WEB API to receive a request from a Client application to save Contact Information, and I need to send an Error Message only if the data has an error; otherwise nothing TODO

Earlier I Used a Dictionary<string, string>

For Example:

Dictionary<string, string> error = new Dictionary<string, string> { {"SaveContactMethod_1", "FirstName Invalid"}, {"SaveContactMethod_2", "LastName Invalid"}, {"SaveContactMethod_3", "MiddleName Invalid"}, }

the respective JSON Object is

{ "error" : { "SaveContactMethod_1":"FirstName Invalid", "SaveContactMethod_2":"LastName Invalid", "SaveContactMethod_3":"MiddleName Invalid" } }

But I need an UNIQUE Key (i.e., Duplicate Key), So I changed the Dictionary<string, string> to List<KeyValuePair<string, string>>

List<KeyValuePair<string, string>> error = new List<KeyValuePair<string, string>> { new KeyValuePair<string, string>("SaveContactMethod", "FirstName Invalid"), new KeyValuePair<string, string>("SaveContactMethod", "LastName Invalid"), new KeyValuePair<string, string>("SaveContactMethod", "MiddleName Invalid"), }

the respective JSON Object is

{ "error" : [ { "key":"SaveContactMethod", "value":"FirstName Invalid" }, { "key":"SaveContactMethod", "value":"LastName Invalid" }, { "key":"SaveContactMethod", "value":"MiddleName Invalid" } ] }

My Requirement: I need to add a Duplicate Key and I need the Json Output like a Dictionary.

Expected Output: JSON

{ "error" : { "SaveContactMethod":"FirstName Invalid", "SaveContactMethod":"LastName Invalid", "SaveContactMethod":"MiddleName Invalid" } }
Improve this question
17
  • 30
    Maybe you need to talk to your client and explain to them this is a stupid requirement likely to introduce all sorts of problems down the road? Commented Feb 22, 2017 at 8:45
  • 55
    Yes, technically that is valid JSON, however, it's meaning according to the spec is that preceding duplicate keys are ignored. Hence the warnings in your online tools. The JSON is invalid if you care about the integrity of your data. Since you do care about the integrity, you can no longer call it JSON. It's now your own custom format that happens to resemble JSON Commented Feb 22, 2017 at 11:00
  • 61
    And in a few days, we'll see a question from another developer from this company: "How do I parse JSON with duplicate keys? I need all the values, but my library only returns the last one." Oh, well... Commented Feb 23, 2017 at 7:30
  • 23
    @B.Balamanigandan: I'm talking about the poor guy who will have to parse the output you are creating, not about you. :-) Commented Feb 23, 2017 at 8:32
  • 37
    Any time you find yourself saying "I need a duplicate key", I think it's time to rethink your design. Commented Feb 23, 2017 at 11:49

2 Answers 2

Reset to default
129

You have a classic "XY" problem. You have asked "How do I do X", but you really need to do Y and you think that X is the only way to get to Y -- but X is either impossible or very hard. By changing your requirements a little, you can get to Y a different way, but you haven't seen that yet since you're stuck on X.

Here's your X: the JSON format that you want to get:

{ "error" : { "SaveContactMethod":"FirstName Invalid", "SaveContactMethod":"LastName Invalid", "SaveContactMethod":"MiddleName Invalid" } }

This will, as others have said, throw away all the error messages except for one when you load it into your C# code.

However, there's a very simple way to get all the error messages. You simply need to change the JSON you're expecting to look something like this instead:

{ "error" : { "SaveContactMethod": [ "FirstName Invalid", "LastName Invalid", "MiddleName Invalid" ] } }

If you only had a single error message, you should still use a list:

{ "error" : { "SaveContactMethod": [ "FirstName Invalid" ] } }

That way when you load the JSON into your C# code, it will always have the same type, Dictionary<string,List<string>>, whether there was one error or many.

That's the Y in your XY problem. Instead of beating your head against the wall of "I want to have duplicate keys in JSON", find a way around the wall: have a single key with a list of values. And now you can do what you really needed, which is to get all the error messages from your form with just a single key name for every single error message.

Improve this answer
Sign up to request clarification or add additional context in comments.

Comments

107

No, this is not possible.

This would be invalid* JSON:

{ "error" : { "SaveContactMethod":"FirstName Invalid", "SaveContactMethod":"LastName Invalid", "SaveContactMethod":"MiddleName Invalid" } }

You can check this here:

Warning:Duplicate key, names should be unique.[Code 23, Structure 9] Warning:Duplicate key, names should be unique.[Code 23, Structure 13]

*Depending on what you call valid

If you realy want to go this route, according to RFC 4627, you could use the StringBuilder class.

Since you don't seem to understand, what Depending on what you call valid means.

ECMA-262:

In the case where there are duplicate name Strings within an object, lexically preceding values for the same key shall be overwritten.

That means: If you get three SaveContactMethod's, you only want "MiddleName Invalid" in ECMA Script (JS). With c# serialization, this would not even be possible. You need to write your own JsonSerializer for it.

Improve this answer

17 Comments

Just to expand on this, it's important to remember that JSON represents an object. You couldn't create an object with duplicate property names in any other OO concept that I know of. Sure it will compile without errors (albeit with warnings), but it won't actually be usable.
I assume what VALID here meaning only the syntax of json string is valid saying that opening and closing is done properly....etc
@Luminous_Dev Really what I'm most curious about here is how in the world the API makes something usable out of JSON with duplicate keys...
Your requirement makes no sence, as long as you need to work with your JSON programmaticaly @B.Balamanigandan. You realy should use a simple errorMessage field, wich is an array of error messages. That's the xy problem.
@B.Balamanigandan, the requirement is not possible. Read the documentation if you need help with StringBuilder. But that is not the way you should do it, and I will not write it for you. This would be way to broad. Change the requirement by talking to the person who give you the requirement. Communicate to this person why it is a bad requirement. Reference to your question here. But that's the end of my part of this discussion. Sorry about that. I also have my projects that needs to be done. Maybe someone else writes a solution that fits your needs. Feel free to downvote my answer.
|

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.