{hero}

ajax.submitAs

Since: DataTables 2.3

Set the data parameter submission format.

Description

When making an Ajax request, there are times which you might wish to submit the data to the server as a JSON string. This is particularly useful in .NET which can easily parse the JSON for you, or in cases with values such as null are important. This option provides that ability.

Typically this option will be used with a POST request where the data is submitted as part of the request body, but if used with GET requests, the JSON string will be used as the query string on the URL.

Backwards compatibility note: This option was introduced in DataTables 2.3, replacing the ability of ajax.data used as a function returning a string. This is an important change as it allows extensions and any other listeners for preXhr to be able to work with object based data, while still providing the ability to send a JSON string to the server. This option is highly recommended over a string return from ajax.data.

Type

string

This option can take one of the following values:

  • http: Submit the data as individual HTTP parameters (default, used if undefined)
  • json: Submit the data as a JSON string.

Default

  • Value: http

Example

Submit data as a POST with JSON in the request body:

new DataTable('#myTable', {
	ajax: {
		contentType: 'application/json',
		submitAs: 'json',
		type: 'POST',
		url: 'data.json'
	}
});

Related

The following options are directly related and may also be useful in your application development.