Asp.net: jQuery Ajax JSON Example, C# WebMethod with SQL Database

/ Updated : / 17 Comments

Overview:  Here in this article will see asp.net jQuery Ajax JSON example, i.e. calling jQuery Ajax WebMethod and get JSON format result (JSON data) in Asp.net C# Webform. In short a simple jQuery Ajax JSON example in Asp.net C# with MS SQL Server database.

If you are looking for how to get JSON formatted result from jquery ajax call in asp.net C#, then this post will explain step by step process. You can also check 3 way to convert DataTable into JSON String in Asp.net C#.

What is jQuery AJAX?

AJAX stands for Asynchronous JavaScript and XML and with using ajax we load data from the server without reloading the whole web page refresh. i.e we can update a specific part of our web page dynamically without page refresh. By using jQuery AJAX methods, we can request HTML, XML, or JSON from the server using both HTTP Get and HTTP Post request.

Am assuming you are aware of Asp.net C# Webservice, i.e., (ASMX file) Webservice.ASMX, WebMethods and familiar with jQuery Ajax syntax.

And it's very useful if you want to save or insert data into the database without page postback or page refresh .i.e Insert data into database using jQuery Ajax.

In this tutorial, we make a jQuery Ajax call and in response will get the JSON data, i.e., here we get a list of all cars and other detail information from our database ( MS SQL server) via WebMethod (ASMX file).

Steps to create jQuery Ajax JSON example in Asp.net C#.

  1. Download the jQuery library and add Html Markup.
  2. Calling jQuery Ajax method.
  3. C#: Create Class and WebMethod, which returns JSON Object.
Fig 1: Asp.net c# jQuery Ajax Json example with MS SQL sever database

# Download the jQuery library and add Html Markup.

First, we open Visual Studio IDE, create a new project and then we added new Asp.net web page and named as myJsonTuts.aspx. On our Asp.net web page, we add a button control and import jQuery library.

You can download jQuery files from jQuery.com, or you can use Google hosted files. So now our HTML markup looks like as shown below.

<head>
 <script src="latestJs_1.11/jquery.min.js"></script>
</head>
<body>
<form runat="server">
<div>
  <select id="ddlSelectYear">
    <option>2014</option>
    <option>2015</option>
  </select> 
  <button id="myButton">Get Car Lists</button> 
  <div id="contentHolder"></div>
</div> 
</form> 
</body>

# Client-Side: Calling jQuery Ajax method.

Now we write client-side code .i.e.  on button click we make a jQuery Ajax call with returns JSON data, check this for dynamic button click event in jQuery.

Here in our case, we fetch the list of cars along with other information from the database MS SQL server via C# WebMethod, which we create later on server-side.

Let's first check how our Client side  code looks as shown below

//*
$("#myButton").on("click", function (e) {
    e.preventDefault();
    var aData= [];
    aData[0] = $("#ddlSelectYear").val(); 
    $("#contentHolder").empty();
    var jsonData = JSON.stringify({ aData:aData});
    $.ajax({
        type: "POST",
        //getListOfCars is my webmethod   
        url: "WebService.asmx/getListOfCars", 
        data: jsonData,
        contentType: "application/json; charset=utf-8",
        dataType: "json", // dataType is json format
        success: OnSuccess,
        error: OnErrorCall
    });
   
    function OnSuccess(response) {
      console.log(response.d)
    }
    function OnErrorCall(response) { console.log(error); }
    });
//*

Here in above code on our button click, we make an ajax call.

You may notice we have set dataType="json" that is because we want our ajax response in JSON format.

# Creating a class and WebMethod, which returns list collection as JSON data.

Now we add a Webservice file (ASMX file) in our project, here we added a file and named as myfunction.asmx.  In our Webservice (.asmx file) we also created a class .i.e Cars which has property as carName, carRating, carYear.

Now we write a WebMethod as we want to get the list of all cars,  here getListofCars is our WebMethod, which fire the select query to the database, pull the record from the database and add it to our class object Car.

In response, we return this Car class object.

    //Created a class 
    public class Cars
    {
        public string carName;
        public string carRating;
        public string carYear;
    }
Now we write our WebMethod, which returns List of Cars details.
[WebMethod]
public List<Cars> getListOfCars(List<string> aData)
{
    SqlDataReader dr;
    List<Cars> carList = new List<Cars>();

    using (SqlConnection con = new SqlConnection(conn))
    {
        using (SqlCommand cmd = new SqlCommand())
        {
            cmd.CommandText = "spGetCars";
            cmd.CommandType = CommandType.StoredProcedure;
            cmd.Connection = con;
            cmd.Parameters.AddWithValue("@makeYear", aData[0]);
            con.Open();
            dr = cmd.ExecuteReader(CommandBehavior.CloseConnection);
            if (dr.HasRows)
            {
                while (dr.Read())
                {
                    string carname = dr["carName"].ToString();
                    string carrating = dr["carRating"].ToString();
                    string makingyear = dr["carYear"].ToString();

                    carList.Add(new Cars
                                    {
                                        carName = carname,
                                        carRating = carrating,
                                        carYear = makingyear
                                    });
                }
            }
        }
    }
    return carList;
}

 In response, we will get data in JSON format,  check this in your browser console, JSON format list of cars is available as shown above in Fig 1.

function OnSuccess(response.d)) {
   console.log(response.d)
}

Note: Always use response.d to get the jquery ajax response in Asp.net C#.

Now we write some more code on our client-side .i.e how to display JSON data list of the car into our Web page.

In short, we have to write some jQuery code to handle the response `JSON Data`. So now our success function looks like as shown below.

function OnSuccess(response) {
    var items = response.d;
    var fragment="<ul>"
    $.each(items, function (index, val) {
                                            
        var carName = val.carName;
        var carRating = val.carRating;
        var carYear = val.carYear;
        fragment += "<li> "+carName+" :: "+carRating+" - "+carYear+"</li>";
    });
    $("#contentHolder").append(fragment);
}

Here we stored the response in variable item and then  using the jQuery $.each() method we make a loop over data, get and set the value to '<li>' tag and append to parent `<UL>`

# OutPut: Asp.net ajax JSON example:

Finally, our Output which displays the list of car and other information.


Conclusion:  In this article, we learn how to make a jquery ajax call in Asp.net C# .ie using WebMethod ( .asmx file) and returns JSON format data. Also, we display this JSON data into our HTML .i.e onSuccess method we create a List of  Cars with other information ( Li tag) using JSON data.

You must also check these articles:

Other Reference:

Thank you for reading, pls keep visiting this blog and share this in your network. Also, I would love to hear your opinions down in the comments.

PS: If you found this content valuable and want to do a favor, then Buy me a coffee

Subscribe to our newsletter

Get the latest and greatest from Codepedia delivered straight to your inbox.


Post Comment

Your email address will not be published. Required fields are marked *

17 Comments

  1. nacho 07/02/2015 20:44:14

    Hi, i'm having this error: Synchronous XMLHttpRequest on the main thread is deprecated because of its detrimental effects to the end user's experience. For more help, check http://xhr.spec.whatwg.org/. browserLink:37 Setting 'XMLHttpRequest.withCredentials' for synchronous requests is deprecated. what am i doing wrong?. Thanks

  2. Satinder singh 07/03/2015 05:26:18

    To avoid this warning, do not use `async: false` in any of your `$.ajax()` calls. This is the only feature of XMLHttpRequest that's deprecated. You can resolve this by adding `async: true` in your '$.ajax()` call which is by default set as true

  3. SJ 12/15/2015 16:06:31

    Hi, I tried creating a new database with database fields, carname, carrating, and caryear. But I cant seem to query the fields in the codes above. May in know more about your connection string to query from the database and also your stored procedure, 'spGetCars'. Thanks

  4. Marcel Girgis 01/05/2016 16:07:20

    What does the mark-up for contentHolder" look like?"

  5. Jhon 01/20/2016 08:47:21

    I have this problem: http://stackoverflow.com/questions/34851481/how-to-change-file-to-retrieve-data-from-json . Could you please give me a hint how I may solve it? Many thanks in advance!

  6. Gerardo 03/30/2016 14:03:40

    help please! error 500 (Internal Server Error)

  7. Gerardo 03/30/2016 14:05:56

    help please!! error 500 (Internal Server Error)

  8. Satinder singh 03/30/2016 16:45:44

    Hi Gerardo, Error 500 (Internal Server Error) mostly occurs if your Webmethod URL is wrong, Pls enter jQuery ajax method URL property with valid path.

  9. kamlesh 07/12/2016 10:58:04

    need help ,how write a jquery function to display the name list from a customer database table as a help list as soon as the textbox get focus in the web form (asp.net with c#) , and second thing is the selected data from the help list should be displayed on the textbox also

  10. Satinder singh 07/12/2016 11:14:11

    Hi Kamlesh, You need to say you want to use jquery ajax based Autocomplete in your web from, then pls refer http://www.dotnetcurry.com/ShowArticle.aspx?ID=515

  11. Ben 08/10/2016 01:31:48

    Excellent, this helped me a lot.

  12. Satinder singh 08/10/2016 06:01:20

    Thanks Ben, Am glad you find it useful.

  13. Satinder singh 09/16/2016 07:10:00

    Hi EvaTomlison, Here we use two files .i.e (Default.aspx and myFunction.asmx) <ol> <li><strong>Default.aspx :</strong> Here we put out HTML markup and jquery ajax code with success and error method.</li> <li><strong>myFunction.asmx.cs :</strong> Here we write the WebMethod and the Class.</li> </ol> Hope now you got a clear idea about using jquery ajax with JSON data in asp.net

  14. Othmane 02/03/2017 17:13:47

    Hello, Keep smiling :) thank you

  15. Black_Giser 02/23/2017 11:31:06

    it happened that System.IndexOutOfRangeException: index overranging the limitation.when using the webservice.Please help me.Thanks.

  16. Satinder singh 04/06/2017 15:34:06

    Refer this <a href=http://stackoverflow.com/questions/20940979/what-is-an-indexoutofrangeexception-argumentoutofrangeexception-and-how-do-i-f" target="_blank" rel="nofollow">StackOverflow Link</a>"

  17. zabeel khan 06/27/2017 15:07:49

    thank u sir