Returning JSON with web api

Question

I am using the following to talk to a web api endpoint controller. The problem I am having is that it returns xml instead of json. From what I understand you need to pass the content type like below to determine the return type, that is why I have it set to JSON. I am stumped as to how to return json.

$.ajax({
    url: 'http://localhost:43043/api/main?ordernumber=33232048&category=damage',
    type: 'GET',
    contentType: "application/json; charset=utf-8",
    //data: {
    //    orderNumber: num,
    //    category: cat
    //},
    success:
           function (data) {
               var usingRoutData = document.URL;
               ko.applyBindings(new InvoiceViewModel(data));
           },

    error: function () {
        alert('failure');
    }

});

you need dataType:"json" as one of the options for the .ajax call, and of course make sure the server is outputting valid json code. — Patrick Evans
– Patrick Evans, Commented Jul 22, 2013 at 19:29
you would need to modify your server-side script and tell IT to return json. the client doesn't just take whatever is sent and convert it to your expected data format. If it's returning XML, it's a server-side problem, not client-side/javascript. — user400654
– user400654, Commented Jul 22, 2013 at 19:34
possible duplicate of How do I get ASP.NET Web API to return JSON instead of XML using Chrome? — mikeswright49
– mikeswright49, Commented Jul 22, 2013 at 19:34
It's all about content negotiation, Web API will choose the best fit among available formats. Disabling all formats on the web api configuration except JSON or adding an Accept header in the ajax call would be equally acceptable solutions to your problem. It all depends on whether you always need JSON responses or just this once. — elolos
– elolos, Commented Jul 25, 2013 at 12:45

Musa · Accepted Answer · 2013-07-22 19:31:22Z

2

I believe you need to set the Accept header setting content type header for a get request doesn't really make sense.

$.ajax({
    url: 'http://localhost:43043/api/main?ordernumber=33232048&category=damage',
    type: 'GET',
    headers: {'Accept':'application/json'}, 
    //data: {
    //    orderNumber: num,
    //    category: cat
    //},
    success:
           function (data) {
               var usingRoutData = document.URL;
               ko.applyBindings(new InvoiceViewModel(data));
           },

    error: function () {
        alert('failure');
    }

})

;

answered Jul 22, 2013 at 19:31

Musa

97.9k17 gold badges123 silver badges144 bronze badges

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

Comments

James Wilson · Accepted Answer · 2013-07-22 19:30:49Z

0

Have you tried setting the dataType property:

dataType: "json",

http://api.jquery.com/jQuery.getJSON/

answered Jul 22, 2013 at 19:30

James Wilson

2893 silver badges13 bronze badges

1 Comment

James Wilson Over a year ago

Not enough rep to reply to Kevin B's comment above. He's using Web API which will, by default, will return the type asked for by the client (XML or JSON).

Collectives™ on Stack Overflow

Returning JSON with web api

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related