MVC Controller Return Content vs Return Json Ajax

Question

In MVC, why does returning Content sometimes fail in the Ajax callback, while returning Json works, even for simple string objects?

Even when it fails, the data is still available if you were to access it in the always callback...

Update:

When I set the contentType in the ajax call to text/xml the response will no longer enter the error message.

AJAX:

$.ajax({
    cache: false,
    type: "GET",
    contentType: "application/json; charset=utf-8",
    dataType: 'json',
    url: "/MyController/GetFooString",
    data: { },
    success: function (data) {
        alert(data);
    },
    error: function (xhr, ajaxOptions, thrownError) {
        alert("Ajax Failed!!!");
    }
}); // end ajax call

Controller Action That Fails (Sometimes)

Even when it fails, the data is still available.

public ActionResult GetFooString()
{
    String Foo = "This is my foo string.";
    return Content(Foo);
} // end GetFooString

Controller Action That Always Works

public ActionResult GetFooString()
{
    String Foo = "This is my foo string.";
    return Json(Foo, JsonRequestBehavior.AllowGet);
} // end GetFooString

Define "fails." What is the actual response returned from the server and how does it differ from a "successful" response? — David
– David, Commented Sep 22, 2014 at 20:24
It enters the error function in the Ajax method even though the data is returned correctly, and without any errors. Successful response is triggered in the Ajax Success method, where I alert data. — disappointed in SO leadership
– disappointed in SO leadership, Commented Sep 22, 2014 at 20:27
Try adding contentType: "application/json", to your parameters list. — Scottie
– Scottie, Commented Sep 22, 2014 at 20:29
@silencedmessage: In order for there to be any difference in the handler, something about the response must be different. Its content, its headers, something. — David
– David, Commented Sep 22, 2014 at 20:34
@David Returning content doesn't fail if I change the content-type to text/xml in the Ajax call. A coworker had a theory that Content returns a string object that is translated as plain text, whereas returning json explicitly returns a json object. — disappointed in SO leadership
– disappointed in SO leadership, Commented Sep 22, 2014 at 20:47

Mrchief · Accepted Answer · 2014-09-22 21:08:45Z

16

Using Content(Foo); sends a response that doesn't have the mime type header. This happens because you're not setting ContentType when using this overload. When the Content-Type is not set, jQuery will try to guess the content type. When that happens, whether it can successfully guess or not depends on the actual content and underlying browser. See here:

dataType (default: Intelligent Guess (xml, json, script, or html))

Json(...) on the other hand explicitly sets the content type to "application/json" so jQuery knows exactly what to treat the content as.

You can get consistent result from Content if you use the 2nd overload and specify a ContentType:

return Content(Foo, "application/json"); // or "application/xml" if you're sending XML

But if you're always dealing with JSON, then prefer using JsonResult

return Json(Foo, JsonRequestBehavior.AllowGet);

edited Sep 22, 2014 at 21:08

answered Sep 22, 2014 at 21:02

Mrchief

76.4k20 gold badges145 silver badges193 bronze badges

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

3 Comments

emerson.marini Over a year ago

+1. But if the OP will always expect JSON, wouldn't be better to just change ActionResult to JsonResult?

Mrchief Over a year ago

@MelanciaUK: If one always expects JSON, then yes. But I see your point. Updating my answer...

disappointed in SO leadership Over a year ago

In this case, I would always be expecting JSON, but the part that I was truly missing was the mime type and the differences between ContentResult and JsonResult.

Collectives™ on Stack Overflow

MVC Controller Return Content vs Return Json Ajax

Update:

AJAX:

Controller Action That Fails (Sometimes)

Controller Action That Always Works

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

Update:

AJAX:

Controller Action That Fails (Sometimes)

Controller Action That Always Works

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related