ASP.NET MVC - How To Use AJAX With JSON Parameters

JSON input format is one of the most widely-used input formats for complex data sharing. In an Ajax call, it is necessary to send complex data as input according to the business requirements. Since, complex or large input parameters are difficult to manage and share in Ajax call, therefore it is recommended to utilize the power of JSON input format.

Today, I shall be demonstrating the integration of Ajax call by passing JSON format input query parameters using the ASP.NET MVC5 platform.

ASP.NET MVC - How To Use AJAX With JSON Parameters

Prerequisites

Following are some prerequisites before you proceed any further in this tutorial,

Knowledge of Jquery.
Knowledge of HTML.
Knowledge of JavaScript.
Knowledge of Bootstrap.
Knowledge of ASP.NET MVC5.
Knowledge of C# Programming.

The example code is being developed in Microsoft Visual Studio 2019 Professional.

Let's begin now.

Step 1

Create a new MVC web project and name it "MVCAjaxWithJsonParam".

Step 2

Create target "JSON object Mapper" object class file according to the business requirements.

Step 3

Create a "Controllers\HomeController.cs" file with default Index method and GetData(...) method with string type input query parameters for Ajax call with following lines of code i.e.

...
public ActionResult GetData(string jsonInput = "")
{
// Initialization.
JsonResult result = new JsonResult();
DataTable data = DataTable();
...
// Deserialize Input JSON String into target Object Mapper.
RequestObj reqObj = JsonConvert.DeserializeObject<RequestObj>(jsonInput);
...
// Load Data.
...
// Filter data with JSON input query parameters.
...
// Prepare Ajax Response as JSON Data Result.
result = this.Json(JsonConvert.SerializeObject(data), JsonRequestBehavior.AllowGet);
...
// Return info.
return result;
}
...

In the above code, I have created a simple “GetData(…)” method which will return a data result response in JSON format using ActionResult data type for the client-side Ajax call. This Ajax method will take a single string parameter as a JSON string input request query parameter. The most important step in the above code is to deserialize the JSON input request query string into a target JSON object mapper according to the business requirements. Then I have loaded my required data in a DataTable structure and then, I have applied the JSON string input query filter with OR condition and finally, I have prepared my JSON response.

Step 4

Now, create the subsequent view "Views\Home\Index.cshtml"of "Controllerss\HomeController.cs" index method and add table HTML tag as shown below i.e.

...
<table class="table table-responsive table-striped table-bordered table-hover"
id="TableId"
cellspacing="0"
align="center"
width="100%">
</table>
...

In the above code, I have created a simple responsive Bootstrap style HTML table tag structure. I will populate the data in this table using Ajax call.

Step 5

Now, create the JavaScript file "Scripts\script-custom-ajax.js" with the following lines of code i.e.

...
$(document).ready(function ()
{
// Initialization
var jsonInput = { CustomerID: 23, Firstname: "John" };
$.ajax(
{
type: 'POST',
dataType: 'JSON',
url: '/Home/GetData',
data: { jsonInput: JSON.stringify(jsonInput) },
success:
function (response)
{
// Generate HTML table.
convertJsonToHtmlTable(JSON.parse(response), $("#TableId"));
},
error:
function (response)
{
alert("Error: " + response);
}
});
...
});
...

In the above code, it is important to prepare your JSON object and then convert that JSON object into JSON string. So, I have made an Ajax call to my server-side at the load of the page to get JSON input request query based filter data. To do so, I have converted my input request query JSON object into JSON string and then I have made the suitable Ajax call as shown in the above code. After receiving the processed JSON data from the server-side, I have loaded the JSON data into HTML table, you can utilize any logic of your own to convert JSON data into HTML table.

Step 6

Now, execute the provided solution and you will be able to see the following in action i.e.

Conclusion

In this article, you learned about the integration of Ajax calls by passing JSON format input query parameters using ASP.NET MVC5 platform. You also learned to create server-side method, which will be called by client-side Ajax call using Jquery. You learned to make a simple client-side Ajax call at the load of the page. You learned to convert client-side JSON object into a JSON string. You learned to pass JSON input request query to the Ajax call and finally, you learned to deserialize the Input request query JSON string into target JSON object mapper according to the business requirements.