How to return JSON from webservice

Question

Morning,

I need to return a message from my web service. Below is a sample of my code, and i am returning a string.

[web method]
public string CheckFeedSubmission()
    {
        string responseText = "";
        try
        {
            //Stuff goes here
            responseText = "It Worked!"
        }
        catch (Exception ex) { responseText = "Opps wehave an error! Exception message:" + ex.Message; }
        return responseText ;
    }

I currently get the following response...

<string xmlns="http://tempuri.org/"/>

I would ideally like to return something like

 {"success" : true, "message" : "***Message Here***"}

I am sure once i get the idea of it, i will be able to return other items if needed. Its just this base i need to work out.

All help is much appreciated, thanks in advance :)

UPDATE: Just found this...

 return "{Message:'hello world'}"

Would i need something like

 responseText = "{"success" : true, "message" : \"There has been an error. Message: " + ex.Message + "\"}"

possible duplicate of [web service should return json](http://stackoverflow.com/questions/8205081/web-service-should-return-json) — Ascendant, Feb 19 '14 at 23:47

score 14 · Accepted Answer · edited Feb 22 '13 at 16:02

14

Use:

[WebMethod]
[ScriptMethod(ResponseFormat = ResponseFormat.Json)]//Specify return format.
public string CheckFeedSubmission()
    {
        string responseText = "";
        try
        {
            //Stuff goes here
            responseText = "It Worked!"
        }
        catch (Exception ex) { responseText = "Opps wehave an error! Exception message:" + ex.Message; }
        return responseText ;
    }

The result returned will be like:

<string xmlns="http://tempuri.org/"/>
 {"success" : true, "message" : "***Message Here***"}
</string>

edited Feb 22 '13 at 16:02

Luis

5,786
8
43
62

answered Jul 12 '12 at 08:10

Ashwin Singh

7,197
4
36
55

3

Thanks, but as above i still get XML string back – thatuxguy Jul 12 '12 at 08:16
1

Actually it returns Json inside the XML. You need to specify in your call what you want to return. Why it returns in the format? http://haacked.com/archive/2009/06/25/json-hijacking.aspx – Ashwin Singh Jul 12 '12 at 08:23
Have a re-look at the answer. – Ashwin Singh Jul 12 '12 at 08:26
and is there no way to remove the element? – thatuxguy Jul 12 '12 at 08:27
1

Yes you can, have a look, http://stackoverflow.com/questions/1121559/asp-net-json-web-service-always-return-the-json-response-wrapped-in-xml – Ashwin Singh Jul 12 '12 at 08:27
1

arr i see, just tested in my app rather than my actual web service and its returning json. Just need to format it so I have what i want returning :) Would i be assuming correctly if i add a bool like i did with the responseText to pass over a true/false ? – thatuxguy Jul 12 '12 at 08:48
How to get complete JSON form with out any XML Tag ! – Syed Hamza Hassan Jul 04 '19 at 11:18

score 2 · Answer 2 · answered Jul 12 '12 at 08:11

2

Please use the attribute for your webmethod

   [WebMethod]
    [ScriptMethod(ResponseFormat = ResponseFormat.Json)]

The caller will have set his contenttype to application/json to use the webmethod

answered Jul 12 '12 at 08:11

HatSoft

11,077
3
28
43

3

does not work, still only get a string back - It worked alright – thatuxguy Jul 12 '12 at 08:16

score 1 · Answer 3 · edited May 23 '17 at 12:09

1

To remove the XML tags in your service response, see this answer on StackOverflow:

ASP.NET WebService is Wrapping my JSON response with XML tags

edited May 23 '17 at 12:09

Community

1
1

answered Nov 17 '14 at 13:50

kalenwatermeyer

741
12
24

score 0 · Answer 4 · edited Sep 22 '14 at 10:33

Try this one :

[WebMethod] 
[ScriptMethod(ResponseFormat = ResponseFormat.Json)]//Specify return format. 
public bool addUser(UserModel um)
    {
        bool result = false;
        result = Conversion.intToBool(SplashAwardsDB.executeNonQuery(
            "INSERT INTO dbo.User ("
            + "userName, password, firstName, lastName, address, contactNo, birthDate, familyID, familyRole, x, y ) "
            + " VALUES ("
            + "'" + um.userName + "', "
            + "'" + um.password + "', "
            + "'" + um.firstName + "', "
            + "'" + um.lastName + "', "
            + "'" + um.address + "', "
            + "'" + um.contactNo + "', "
            + "'" + um.birthDate + "', "
            + "'" + um.familyID + "', "
            + "'" + um.familyRole + "', "
            + "'" + um.x + "', "
            + "'" + um.y + "')"
            ));
        return result;
    }

score 0 · Answer 5 · answered Apr 22 '18 at 21:13

This my solution for the framewok 4.5.2, In the class FilterConfig add the following code, Note: you will need the lib Newtonsoft.

 public class FilterConfig
{
    public static void RegisterGlobalFilters(GlobalFilterCollection filters)
    {
        GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Serialize;
        GlobalConfiguration.Configuration.Formatters.Remove(GlobalConfiguration.Configuration.Formatters.XmlFormatter);
        GlobalConfiguration.Configuration.EnableCors();
        filters.Add(new HandleErrorAttribute());
    }
}

How to return JSON from webservice

5 Answers5

Linked