JsonResults returns Enum value instead of String representation

Question

On my Client Side I have an ajax call like below:

          $.ajax({
                url: "Controller/ListResult",
                type: 'POST',
                contentType: "application/json;charset=utf-8",
                data: JSON.stringify({
                    Id: ObjectId,
                    SessionKey: sessionManager.getSessionKey()
                }),
                dataType: "json",
                success: function (result) {
                var test = results;
                    }
                }
            });

In the Controller I have a method like this :

      [HttpPost]
       public JsonResult ListResult(string Id, string SessionKey)
       {
        IBl biz = new BL();
        var result = biz.GetResults(Id,SessionKey);
        return Json(result);
       }

The problem is the result that controller returns is an object which has Enum properties (with their string representation as value). However when it reaches the success function in the ajax call, the enums are no longer string representation, and instead, they have been converted to their int values. How can I avoid this? and keep the string representation on the javascript side.

@StephenMuecke, it is an internal function to retrieve session, but this shouldn't affect anything. Because it works as expected. — Benjamin
– Benjamin, Commented Nov 3, 2016 at 3:34
You will need to create an anonymous object to represent your data and use ToString() on the enum properties (the JavascriptSerializer serializes enums to their numeric values and not their string representation) — user3559349
– user3559349, Commented Nov 3, 2016 at 3:43
Hi Benjamin , Can you try this one out return Json(result.ToList(), JsonRequestBehavior.AllowGet); — Saineshwar Bageri - MVP
– Saineshwar Bageri - MVP, Commented Nov 3, 2016 at 3:45
You can also use Json.NET with the [JsonConverter(typeof(StringEnumConverter))] attribute on your properties — user3559349
– user3559349, Commented Nov 3, 2016 at 3:52

dbc · Accepted Answer · 2016-12-19 05:26:37Z

7

Instead of returning var result create some result entity class and you can mark the enum property there with StringEnumConverter.

class Result
{
  [JsonConverter(typeof(StringEnumConverter))]
  public EnumType EnumProperty { get; set; }

  *****other properties goes here****
}

As Stephen suggested this works if one is using Json.NET as the serializer.

edited Dec 19, 2016 at 5:26

dbc

120k27 gold badges273 silver badges404 bronze badges

answered Nov 3, 2016 at 3:52

Navoneel Talukdar

4,6365 gold badges23 silver badges43 bronze badges

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

1 Comment

user3559349 Over a year ago

Only if OP is using Json.NET as the serializer :)

Jimmy Joe · Accepted Answer · 2016-11-03 03:55:53Z

3

Try something like this:

    var result = biz.GetResults(Id,SessionKey);
    var modifiedResult = new
      {
        ...,
        r.EnumValue.ToString(),
        ...
      };
    return Json(modifiedResult);

edited Nov 3, 2016 at 3:55

answered Nov 3, 2016 at 3:36

Jimmy Joe

1218 bronze badges

4 Comments

Benjamin Over a year ago

As I said the result in the Controller is already String representation, and there is no need to ToString() it. It just gets converted to int value when it reaches to the Javascript side.

Jimmy Joe Over a year ago

If the properties in the result getting returned by the Controller are Enums, the call to return Json(result) will convert those strings back to their integer values. If you project the result first into an anonymous type then the properties will just be strings.

user3559349 Over a year ago

Almost right - but you cannot use .Select() on a single object (which is what OP stated the GetResults() method returns

Jimmy Joe Over a year ago

@Stephen -- thanks for the feedback, answer has been updated.

Collectives™ on Stack Overflow

JsonResults returns Enum value instead of String representation

2 Answers 2

1 Comment

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related