Enum Serialization Json vs XML

Question

I have following Enum in my project

public enum CameraAccessMethod
{
    Manual = 0,
    Panasonic = 1,
    Axis = 2,
    AirCam = 3
}

I have an object that is serialized either to json or to XML depending upon different scenarios and one of object's property is of type CameraAccessMethod. The problem i have is that when this property is serialized to XML it will give string representation of enum values (Manual, Panasonic,Axis,Aircam) but in JSON it is serialized to number values (0,1,2,3). How can i avoid this inconsistency? i want strings in JSON serialization as well.

How are you doing the JSON serialization? Depending on which serializer you use, it may or may not have an option of serializing enum values as strings. — carlosfigueira, May 19 '12 at 14:51
I am using default serializer that ships with asp.net web api beta — Muhammad Adeel Zahid, May 20 '12 at 19:28
possible duplicate of [JSON serialization of c# enum as string](http://stackoverflow.com/questions/2441290/json-serialization-of-c-sharp-enum-as-string) — moribvndvs, May 20 '12 at 23:41

score 36 · Accepted Answer · edited Oct 16 '15 at 11:43

36

Since Web API RC you can get string representations of enums by applying a StringEnumConvert to the existing JsonMediaTypeFormatter converter collection during Application_Start():

var jsonFormatter = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
var enumConverter = new Newtonsoft.Json.Converters.StringEnumConverter();
jsonFormatter.SerializerSettings.Converters.Add(enumConverter);

edited Oct 16 '15 at 11:43

Rikin Patel

8,848
7
70
78

answered Jun 26 '12 at 12:12

Jonas Lundgren

1,031
11
17

Needs a single `;` at the end of line 1 – Michael Bisbjerg Dec 07 '12 at 23:52

score 1 · Answer 2 · edited May 23 '17 at 10:28

1

You can accomplish this easily if you switch to using a formatter based upon Json.NET (which will ship out of the box with next drop of ASP.NET Web API). See this SO post for details:

How to tell Json.Net globally to apply the StringEnumConverter to all enums

edited May 23 '17 at 10:28

Community

1
1

answered May 22 '12 at 05:41

David Peden

17,596
6
52
72

score 0 · Answer 3 · edited Oct 16 '15 at 11:42

To use JsonMediaTypeFormatter and enumConverter both we can use below code. //code start here

var serializerSettings = GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings;
var enumConverter = new Newtonsoft.Json.Converters.StringEnumConverter();
serializerSettings.Converters.Add(enumConverter);
GlobalConfiguration.Configuration.Formatters.Clear();
GlobalConfiguration.Configuration.Formatters.Add(new PartialJsonMediaTypeFormatter()
{
     IgnoreCase = true,
     SerializerSettings = serializerSettings
});

Enum Serialization Json vs XML

3 Answers3

Linked

Related