WebMethod vs ScriptMethod

Steve Johnson picture Steve Johnson · Jun 2, 2009 · Viewed 41.6k times · Source

I have a .NET 3.5 aspx place with a method marked with the [WebMethod] attribute. I'm calling this with jQuery, sending JSON in both directions. This all works great. My question is, what does [ScriptMethod] do when applied to an method? I've tried this and it seems to yield the same result. Are ScriptMethod and WebMethod identical and interchangeable, or does one provide functionality and/or overhead that the other doesn't? In general, I find myself confused with all of the options available for implementing web services and I'd like to know what the pros and cons are for each.

Answer

Shrage Smilowitz picture Shrage Smilowitz · Feb 11, 2010

You use the ScriptMethod attribute in the following 2 scenarios.

  1. You are using jquery or any other ajax request mechanism, but you want the request to be a GET not a POST.
  2. You want to receive an XML formated response in javaScript.

If you don't have one of the above requirements; you just need a JSON response using a an ajax request then you can simply use the WebMethod.

There is still one more confusing element here, when do you use the ScriptService attribute? this is used if you are using the Microsoft Ajax Client script framework, this attributes tell the server to generate proxy objects on the client so that you can call functions just like a normal object. var MyRemoteObject = new RemoteObject(); MyRemoteObject.getMessage(....) and even when you use the ScriptService attribute you don't need to add the ScriptMethod attribute only in the above scenarios.

It was confusing to me at the begining because i thought that the ScriptService and the ScriptMethod attributes works together just like the WebService and WebMethod attributes.