CODEWITHSUNDEEP
xmljsonasmx
JohnnyCantCode
JohnnyCantCode

Reputation: 153

ASP.NET JSON web service always return the JSON response wrapped in XML

I saw a similar question but it did not resolve my issue. I have a JSON web service in an ASMX file;

The code for the web method

        [WebMethod]
        [ScriptMethod(ResponseFormat = ResponseFormat.Json)]
        public string GetUserRoles(string JSONUserCode)
        {
            string retRoles = string.Empty;
            List<JSONRole> roles = new List<JSONRole>();

            {... I Populate the roles here ...}

            DataContractJsonSerializer serializer = new
            DataContractJsonSerializer(roles.GetType());
            MemoryStream ms = new MemoryStream();
            serializer.WriteObject(ms, roles);
            string jsonString = Encoding.Default.GetString(ms.ToArray());
            ms.Close();
            return jsonString;
        }

This correctly formats the List correctly but wraps the entire return in XML. Here is the response:

<?xml version="1.0" encoding="utf-8" ?> 
    <string xmlns="http://formshare.com/">
       [{"Name":"Accounts Payable"},{"Name":"Payroll"}]
    </string>

You can view the Response your self by clicking this link:

http://dev.formshare.gologictech.com/JSON/JSONService.asmx/GetUserRoles?JSONUserCode=1234

I need the response to be just:

[{"Name":"Accounts Payable"},{"Name":"Payroll"}]

Any ideas? Thanks for your help.

Upvotes: 12

Views: 29472

Answers (9)

Devadonn
Devadonn

Reputation: 23

Use like this not return string type.Just write

public void Metod()
    {
        json = jss.Serialize(Data);
        Context.Response.Write(json);
    }

Upvotes: 1

JayC
JayC

Reputation: 39

Instead of returning a string in your WebMethod use:

JavaScriptSerializer js = new JavaScriptSerializer();
Context.Response.Write(js.Serialize(YOUR_STRING_TO_OUTPUT));

Upvotes: 0

Sebastien Binette
Sebastien Binette

Reputation: 31

Turns out it's not dataType that counts but

contentType: 'application/json; charset=utf-8'.

It worked like a charm.

Upvotes: 3

Rama Subba Reddy M
Rama Subba Reddy M

Reputation: 687

Your missed only "static" keyword in method declaration please look into the following it should work.

FYI: All the web methods should be static

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

    public static string GetUserRoles(string JSONUserCode)
    {
        string retRoles = string.Empty;
        List<JSONRole> roles = new List<JSONRole>();

        {... I Populate the roles here ...}

        DataContractJsonSerializer serializer = new
        DataContractJsonSerializer(roles.GetType());
        MemoryStream ms = new MemoryStream();
        serializer.WriteObject(ms, roles);
        string jsonString = Encoding.Default.GetString(ms.ToArray());
        ms.Close();
        return jsonString;
    }

Upvotes: 0

Emre
Emre

Reputation: 11

I made the same mistake by handling the serialization myself. You re not supposed to return string but the object itself.

If you have already developed a hundred Services like this, a work around for you: just created a aspx, ServiceCaller.aspx, remove everything in the html just leave the page directive and use the codebehind to call the service and Response.Write the string. Also take the Service method name as a parameter like "HelloWorld" and use reflection to invoke it.

It's kinda showing your left ear with your right hand but it works. You can also easily integrate a roles management and using reflection get the service name as string check the db if the user can call this service and with reflection Invoke the method.

(any comments on this is welcome :)

Upvotes: 1

Emre
Emre

Reputation: 1

We have made another page that calls the service server side and writes the response (in our case an .aspx). We cleaned up all the HTML code, doctype head body, and made the server side code to call the service and response.write it.

(in aspx case just leave the page directive at the top)

this way you can get a clean string.

By the way if this is exposing our application to any security threats or major performance hits, I'd really appreciate the comments. Just too busy to ask it here or search on it :)

Upvotes: 0

Ivan
Ivan

Reputation: 11

Try Jayrock for .NET, it's a neat handler for .NET JSON RPC. It'll do exactly what you need. There's a step by step how-to for ASP .NET JSON RPC here.

Upvotes: 1

Pavel Morshenyuk
Pavel Morshenyuk

Reputation: 11471

Make sure your service class has [ScriptService] attribute. This attribute is not added by default.

Upvotes: 1

David Hedlund
David Hedlund

Reputation: 129782

The WebMethod is able to serve the same information both as XML and JSON. You need to specify what format you want (dataType) in the client, as you submit your request.

Also, you're not supposed to serialize the object to JSON manually, but rather, return roles, and it will be serialized to JSON if your client requests the data as JSON.

EDIT

jQuery example (note the dataType parameter):

$.ajax({
   type: 'GET',
   url: 'http://dev.formshare.gologictech.com/JSON/JSONService.asmx/GetUserRoles',
   contentType: 'application/json; charset=utf-8',
   dataType: 'json',
   data: '{"JSONUserCode":"1234"}',
   success: myCallback
});

It is worth mentioning that the object will not be returned in exactly the format you specified, but rather, wrapped in an object:

{ d: [ {"Name":"Accounts Payable"}, {"Name":"Payroll"} ] }

This, however, is actually quite desirable, for added security

Upvotes: 12

Related Questions