Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles / web / ASP.NET

Web Service and Script Service

5.00/5 (1 vote)
26 Jan 2013CPOL1 min read 63.5K   581  
Web service and script service

Most of you are familiar with writing a web service using C#. Visual Studio provides the project template which easily creates a web service for you.

Image 1

Image 2

I’m sure you may know how to call this web service using C#. But do you know how to call the web service using client side scripts such as JavaScript? There are various ways to do this. I will demonstrate this using jQuery$.ajax() function.

JavaScript
function callSvc() {
    $.ajax({
        type: "POST",
        url: "Service1.asmx/HelloWorld",
        data: "",
        contentType: "application/json; charset=utf-8",
        dataType: "json",
        success: function(data, status) { alert(data); },
        error: function(request, status, error) { alert(request); alert(status); alert(error); }
    });
} 

When you call the HelloWorld() service, by default you will get “500 – Internal server error” error message.

Image 3

This error is raised because you haven’t configured this service to access using client side scripts. When you check the responseText , you will notice that it says “Only Web services with a [ScriptService] attribute on the class definition can be called from script.

To resolve this, you have to configure your web service with [ScriptService] attribute.

C#
[System.Web.Script.Services.ScriptService]
public class Service1 : System.Web.Services.WebService

When adding [ScriptService] attribute to the web service, it gets automatically handled by the ScriptHandlerFactory and creates a JavaScript proxy class for the web service. That means, you will be able to call the web service from the client side script in the same way as you call it from the code behind. You can view the generated proxy class by using the following command:

http://<URL>/SimpleWebService.asmx/js
http://<URL>/SimpleWebService.asmx/jsdebug

Compare the generated proxy class with the service description (http://<URL>/Service1.asmx?WSDL) and let me know what you noticed.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)