Ajax Send Model To Controller Asp.net Core

The first thing to look at is the key settings options that are available for AJAX requests:

• Asp Net Core Api Controller
• Asp.net Core Model Binding
• Asp.net Core Model Validation

This information is provided at the jQuery site (http://api.jquery.com/jQuery.ajax/) and what is detailed above doesn't add to the official documentation. However, most issues that I have seen relating to jQuery POST requests seem to result from a lack of understanding about how these settings actually work.

• You can still use the model validation framework to check for the property level validation of your view model. Since you are making an ajax call, you need to send the validation errors in a JSON response back to the client where it can display it to the user.
• Join a community of over 2.6m developers to have your questions answered on Model is null on Post to Controller of UI for ASP.NET Core Grid. Start with our free trials.

You can post a range of different data types including form values, arrays, JavaScript objects and JSON. First, it is important to clarify that JavaScript objects and JSON are not the same thing. A JavaScript object is a data type with properties and values. A simple one is represented in JavaScript as follows:

Feb 28, 2019  ASP.NET MVC Show View after Ajax call to a Controller Hot Network Questions After installing magento 2.3.1, page can not open properly.

The syntax is almost identical to the way that you declare an anonymous type in C# - just lacking a new in front of the opening brace and replacing the = with colons. But there are other ways to declare a JavaScript object. Unlike C#, JavaScript object properties can be strings as well as identifiers:

This potentially leads to the confusion between JavaScript objects and JSON, which is a string representation of data. The JSON representation of the car object is syntactically identical:

But JSON is a data interchange format which has a number of rules: the properties must be enclosed in double quotes being one. For that reason, and to reduce confusion, I tend to avoid using quotes around property names in JavaScript objects. Other differences between JavaScript objects and JSON include support for data types: JSON does not yet have an accepted standard for representing datetimes, for example.

Whenever any request is made to an ASP.NET application, the raw content of that request populates the Request.InputStream property. You can access this raw data by using a StreamReader:

If the request content is formatted using a standard encoding such as application/x-www-form-urlencoded, ASP.NET will parse the response for you and populate the Request.Form collection with the name/value pairs taken from the InputStream as a convenience.

Posting JavaScript Objects

When the contentType of an AJAX request is set to application/x-www-form-urlencoded, jQuery will convert the property names and values of a JavaScript object to a query string and url-encode it. The following example POSTs the car object from above:

In the example above, the contentType has not been set so the default application/x-www-form-urlencoded will be used. The dataType option has been set to html, which states that I am expecting the 'Receiver' page to return some HMTL to me. If all goes well with the request, the returned HTML will be plugged in to an element with the id of 'result'. Here's the code for the Receiver.cshtml page:

The code does two things: it outputs the InputStream to the browser, having urldecoded it, and it iterates the Request.Form collection, outputting any name/value pairs it can find there. The result from posting the car object looks like this:

So if you want to post a JavaScript object via jQuery, pass the plain object to the data option, and leave the contentType option alone. The default option is perfect. Then you can access the property values of the object in the Request collection as if you have posted a form.

Posting JavaScript Arrays

If you want to post an array via jQuery, you need to do two things. You must provide a name for the array, and you need to leave the contentType as the default value of application/x-www-form-urlencoded:

Here's what the Receiver page returns:

jQuery uses the name of the array as the key and serialises all array elements with the same key - although interestingly, jQuery adds square brackets to the key value: myArray[]. As far as ASP.NET is concerned, when the request is processed on the server, it is the same as a radio or checkbox group. ASP.NET populates the Request.Form collection with one name/value pair - the name being the key that was generated by jQuery and the value being the array values as a comma-separated string. You can process them by using string.Split:

Posting Form values

I have seen examples of people constructing a JavaScript object out of form values and then posting the result and I am sure there are occasions when it makes sense to do just that. However, in the majority of cases, using the serialize() method is sufficient. This takes the values of the specified elements and serializes them to a query string. Here's a simple form:

Notice that there is no submit button within the form tags. The button lies outside, so it won't submit the form by default. This is all that's needed in the button click event handler:

The serialize command is called on the form element as a whole, which means that all form fields will be included in the request, and again, the contentType is not specified so it falls back to the default application/x-www-form-urlencoded. The result is as below, and is identical if a JavaScript object had been posted with the same properties and values.

Posting JSON

Asp Net Core Api Controller

As I touched on earlier, there is nothing magical about JSON. It is just a data interchange format where values are converted to a string. The format has certain rules that must be followed, and these rules make is easy to create parsers. Why would you use JSON? Well, for one thing, it is much easier to represent a complex object in JSON and to let parsers unpick it on the server. If you posted a complex object using the application/x-www-form-urlencoded format, you would have to parse the response yourself to reconstruct the object on the server. ASP.NET includes some API's for deserialising JSON to objects on the server, including the Json helper for Web Pages.

Asp.net Core Model Binding

How do you create JSON? Most browsers these days include the JSON.stringify method, so that is the recommended way:

On this occasion, the contentType is set to application/json. The dataType is still set to html, since that is the data type of the response I am expecting from the server. And this time, the response shows that the Rsequest.InputStream is the only place where I can get at the posted data on the server.

If I am happy to work with dynamic objects, I can use the dynamic version of Json.Decode on the server to convert the JSON to something I can work with in C#:

Or if I prefer to work with strongly typed objects, I can use the version that takes a type parameter:

Asp.net Core Model Validation

Posting values via jQuery can be confusing at first, but as this article attempted to show, once you have an understanding of the different data types that you can post, and the purpose of the contentType and dataType options, things become a lot clearer.