jQuery.ajax( url [, settings ] )Returns: jqXHR
Description: Perform an asynchronous HTTP (Ajax) request.
-
version added: 1.5jQuery.ajax( url [, settings ] )
- urlA string containing the URL to which the request is sent.
- settingsA set of key/value pairs that configure the Ajax request. All settings are optional. A default can be set for any option with $.ajaxSetup(). See jQuery.ajax( settings ) below for a complete list of all settings.
-
version added: 1.0jQuery.ajax( [settings ] )
-
settingsA set of key/value pairs that configure the Ajax request. All settings are optional. A default can be set for any option with $.ajaxSetup().
-
accepts (default:
depends on dataType
)A set of key/value pairs that map a given
dataType
to its MIME type, which gets sent in the
Accept
request header. This header tells the server what kind of response it will accept in return. For example, the following defines a custom type
mycustomtype
to be sent with the request:12345678910111213141516
$.ajax({
accepts: {
mycustomtype: 'application/x-some-custom-type'
},
// Instructions for how to deserialize a `mycustomtype`
converters: {
'text mycustomtype': function(result) {
// Do Stuff
return newresult;
},
// Expect a `mycustomtype` back from server
dataType: 'mycustomtype'
});
converters
for this to work properly. -
async (default:
true
)By default, all requests are sent asynchronously (i.e. this is set to
true
by default). If you need synchronous requests, set this option to
false
. Cross-domain requests and
dataType: "jsonp"
requests do not support synchronous operation. Note that synchronous requests may temporarily lock the browser, disabling any actions while the request is active. As of jQuery 1.8, the use of
async: false
with jqXHR (
$.Deferred
) is deprecated; you must use the success/error/complete callback options instead of the corresponding methods of the jqXHR object such as
jqXHR.done()
. -
beforeSendType: Function( jqXHR jqXHR, PlainObject settings )A pre-request callback function that can be used to modify the jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object before it is sent. Use this to set custom headers, etc. The jqXHR and settings objects are passed as arguments. This is an Ajax Event. Returning
false
in the
beforeSend
function will cancel the request. As of jQuery 1.5, the
beforeSend
option will be called regardless of the type of request. -
cache (default:
true, false for dataType 'script' and 'jsonp'
)If set to
false
, it will force requested pages not to be cached by the browser. Note: Setting
cache
to false will only work correctly with HEAD and GET requests. It works by appending “_={timestamp}” to the GET parameters. The parameter is not needed for other types of requests, except in IE8 when a POST is made to a URL that has already been requested by a GET. -
completeA function to be called when the request finishes (after
success
and
error
callbacks are executed). The function gets passed two arguments: The jqXHR (in jQuery 1.4.x, XMLHTTPRequest) object and a string categorizing the status of the request (
"success"
,
"notmodified"
,
"nocontent"
,
"error"
,
"timeout"
,
"abort"
, or
"parsererror"
). As of jQuery 1.5, the
complete
setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event. - contentsAn object of string/regular-expression pairs that determine how jQuery will parse the response, given its content type. (version added: 1.5)
-
contentType (default:
'application/x-www-form-urlencoded; charset=UTF-8'
)When sending data to the server, use this content type. Default is “application/x-www-form-urlencoded; charset=UTF-8”, which is fine for most cases. If you explicitly pass in a content-type to
$.ajax()
, then it is always sent to the server (even if no data is sent). As of jQuery 1.6 you can pass
false
to tell jQuery to not set any content type header. Note: The W3C XMLHttpRequest specification dictates that the charset is always UTF-8; specifying another charset will not force the browser to change the encoding. Note: For cross-domain requests, setting the content type to anything other than
application/x-www-form-urlencoded
,
multipart/form-data
, or
text/plain
will trigger the browser to send a preflight OPTIONS request to the server. -
contextThis object will be the context of all Ajax-related callbacks. By default, the context is an object that represents the Ajax settings used in the call (
$.ajaxSettings
merged with the settings passed to
$.ajax
). For example, specifying a DOM element as the context will make that the context for the
complete
callback of a request, like so:123456
$.ajax({
url: "test.html",
context: document.body
}).done(function() {
$( this ).addClass( "done" );
});
-
converters (default:
{"* text": window.String, "text html": true, "text json": jQuery.parseJSON, "text xml": jQuery.parseXML}
)An object containing dataType-to-dataType converters. Each converter’s value is a function that returns the transformed value of the response. (version added: 1.5) -
crossDomain (default:
false for same-domain requests, true for cross-domain requests
)If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to
true
. This allows, for example, server-side redirection to another domain. (version added: 1.5) -
dataType: PlainObject or String or Array
Data to be sent to the server. If the HTTP method is one that cannot have an entity body, such as GET, the
data
is appended to the URL.When
data
is an object, jQuery generates the data string from the object’s key/value pairs unless the
processData
option is set to
false
. For example,
{ a: "bc", d: "e,f" }
is converted to the string
"a=bc&d=e%2Cf"
. If the value is an array, jQuery serializes multiple values with same key based on the value of the
traditional
setting (described below). For example,
{ a: [1,2] }
becomes the string
"a%5B%5D=1&a%5B%5D=2"
with the default
traditional: false
setting.When
data
is passed as a string it should already be encoded using the correct encoding for
contentType
, which by default is
application/x-www-form-urlencoded
.In requests with
dataType: "json"
or
dataType: "jsonp"
, if the string contains a double question mark (
??
) anywhere in the URL or a single question mark () in the query string, it is replaced with a value generated by jQuery that is unique for each copy of the library on the page (e.g.
jQuery21406515378922229067_1479880736745
). - dataFilterA function to be used to handle the raw response data of XMLHttpRequest. This is a pre-filtering function to sanitize the response. You should return the sanitized data. The function accepts two arguments: The raw data returned from the server and the ‘dataType’ parameter.
-
dataType (default:
Intelligent Guess (xml, json, script, or html)
)The type of data that you’re expecting back from the server. If none is specified, jQuery will try to infer it based on the MIME type of the response (an XML MIME type will yield XML, in 1.4 JSON will yield a JavaScript object, in 1.4 script will execute the script, and anything else will be returned as a string). The available types (and the result passed as the first argument to your success callback) are:-
"xml"
: Returns a XML document that can be processed via jQuery. -
"html"
: Returns HTML as plain text; included script tags are evaluated when inserted in the DOM. -
"script"
: Evaluates the response as JavaScript and returns it as plain text. Disables caching by appending a query string parameter,
_=[TIMESTAMP]
, to the URL unless the
cache
option is set to
true
. Note: This will turn POSTs into GETs for remote-domain requests. Prior to jQuery 3.5.0, unsuccessful HTTP responses with a script
Content-Type
were still executed. -
"json"
: Evaluates the response as JSON and returns a JavaScript object. Cross-domain
"json"
requests that have a callback placeholder, e.g.
?callback=?
, are performed using JSONP unless the request includes
jsonp: false
in its request options. The JSON data is parsed in a strict manner; any malformed JSON is rejected and a parse error is thrown. As of jQuery 1.9, an empty response is also rejected; the server should return a response of
null
or
{}
instead. (See json.org for more information on proper JSON formatting.) -
"jsonp"
: Loads in a JSON block using JSONP. Adds an extra
"?callback=?"
to the end of your URL to specify the callback. Disables caching by appending a query string parameter,
"_=[TIMESTAMP]"
, to the URL unless the
cache
option is set to
true
. -
"text"
: A plain text string. -
multiple, space-separated values: As of jQuery 1.5, jQuery can convert a dataType from what it received in the Content-Type header to what you require. For example, if you want a text response to be treated as XML, use
"text xml"
for the dataType. You can also make a JSONP request, have it received as text, and interpreted by jQuery as XML:
"jsonp text xml"
. Similarly, a shorthand string such as
"jsonp xml"
will first attempt to convert from jsonp to xml, and, failing that, convert from jsonp to text, and then from text to xml.
-
-
errorA function to be called if the request fails. The function receives three arguments: The jqXHR (in jQuery 1.4.x, XMLHttpRequest) object, a string describing the type of error that occurred and an optional exception object, if one occurred. Possible values for the second argument (besides
null
) are
"timeout"
,
"error"
,
"abort"
, and
"parsererror"
. When an HTTP error occurs,
errorThrown
receives the textual portion of the HTTP status, such as “Not Found” or “Internal Server Error.” (in HTTP/2 it may instead be an empty string) As of jQuery 1.5, the
error
setting can accept an array of functions. Each function will be called in turn. Note: This handler is not called for cross-domain scripts and cross-domain JSONP requests. This is an Ajax Event. -
global (default:
true
)Whether to trigger global Ajax event handlers for this request. The default is
true
. Set to
false
to prevent the global handlers like
ajaxStart
or
ajaxStop
from being triggered. This can be used to control various Ajax Events. -
headers (default:
{}
)An object of additional header key/value pairs to send along with requests using the XMLHttpRequest transport. The header
X-Requested-With: XMLHttpRequest
is always added, but its default
XMLHttpRequest
value can be changed here. Values in the
headers
setting can also be overwritten from within the
beforeSend
function. (version added: 1.5) -
ifModified (default:
false
)Allow the request to be successful only if the response has changed since the last request. This is done by checking the Last-Modified header. Default value is
false
, ignoring the header. In jQuery 1.4 this technique also checks the ‘etag’ specified by the server to catch unmodified data. -
isLocal (default:
depends on current location protocol
)Allow the current environment to be recognized as “local,” (e.g. the filesystem), even if jQuery does not recognize it as such by default. The following protocols are currently recognized as local:
file
,
*-extension
, and
widget
. If the
isLocal
setting needs modification, it is recommended to do so once in the
$.ajaxSetup()
method. (version added: 1.5.1) -
jsonpOverride the callback function name in a JSONP request. This value will be used instead of ‘callback’ in the ‘callback=?’ part of the query string in the url. So
{jsonp:'onJSONPLoad'}
would result in
'onJSONPLoad=?'
passed to the server. As of jQuery 1.5, setting the
jsonp
option to
false
prevents jQuery from adding the “?callback” string to the URL or attempting to use “=?” for transformation. In this case, you should also explicitly set the
jsonpCallback
setting. For example,
{ jsonp: false, jsonpCallback: "callbackName" }
. If you don’t trust the target of your Ajax requests, consider setting the
jsonp
property to
false
for security reasons. -
jsonpCallbackSpecify the callback function name for a JSONP request. This value will be used instead of the random name automatically generated by jQuery. It is preferable to let jQuery generate a unique name as it’ll make it easier to manage the requests and provide callbacks and error handling. You may want to specify the callback when you want to enable better browser caching of GET requests. As of jQuery 1.5, you can also use a function for this setting, in which case the value of
jsonpCallback
is set to the return value of that function. -
method (default:
'GET'
)The HTTP method to use for the request (e.g.
"POST"
,
"GET"
,
"PUT"
). (version added: 1.9) - mimeTypeA mime type to override the XHR mime type. (version added: 1.5.1)
- passwordA password to be used with XMLHttpRequest in response to an HTTP access authentication request.
-
processData (default:
true
)By default, data passed in to the
data
option as an object (technically, anything other than a string) will be processed and transformed into a query string, fitting to the default content-type “application/x-www-form-urlencoded”. If you want to send a DOMDocument, or other non-processed data, set this option to
false
. -
scriptAttrsDefines an object with additional attributes to be used in a “script” or “jsonp” request. The key represents the name of the attribute and the value is the attribute’s value. If this object is provided it will force the use of a script-tag transport. For example, this can be used to set
nonce
,
integrity
, or
crossorigin
attributes to satisfy Content Security Policy requirements. (version added: 3.4) -
scriptCharsetOnly applies when the “script” transport is used. Sets the
charset
attribute on the script tag used in the request. Used when the character set on the local page is not the same as the one on the remote script. Alternatively, the
charset
attribute can be specified in
scriptAttrs
instead, which will also ensure the use of the “script” transport. -
statusCode (default:
{}
)An object of numeric HTTP codes and functions to be called when the response has the corresponding code. For example, the following will alert when the response status is a 404:
1234567
$.ajax({
statusCode: {
404: function() {
alert( "page not found" );
});
If the request is successful, the status code functions take the same parameters as the success callback; if it results in an error (including 3xx redirect), they take the same parameters as the
(version added: 1.5)
error
callback. -
successA function to be called if the request succeeds. The function gets passed three arguments: The data returned from the server, formatted according to the
dataType
parameter or the
dataFilter
callback function, if specified; a string describing the status; and the
jqXHR
(in jQuery 1.4.x, XMLHttpRequest) object. As of jQuery 1.5, the success setting can accept an array of functions. Each function will be called in turn. This is an Ajax Event. -
timeoutType: NumberSet a timeout (in milliseconds) for the request. A value of 0 means there will be no timeout. This will override any global timeout set with $.ajaxSetup(). The timeout period starts at the point the
$.ajax
call is made; if several other requests are in progress and the browser has no connections available, it is possible for a request to time out before it can be sent. In jQuery 1.4.x and below, the XMLHttpRequest object will be in an invalid state if the request times out; accessing any object members may throw an exception. In Firefox 3.0+ only, script and JSONP requests cannot be cancelled by a timeout; the script will run even if it arrives after the timeout period. -
traditionalSet this to
true
if you wish to use the traditional style of param serialization. -
type (default:
'GET'
)An alias for
method
. You should use
type
if you’re using versions of jQuery prior to 1.9.0. -
url (default:
The current page
)A string containing the URL to which the request is sent. - usernameA username to be used with XMLHttpRequest in response to an HTTP access authentication request.
-
xhr (default:
ActiveXObject when available (IE), the XMLHttpRequest otherwise
)Type: Function()Callback for creating the XMLHttpRequest object. Defaults to the ActiveXObject when available (IE), the XMLHttpRequest otherwise. Override to provide your own implementation for XMLHttpRequest or enhancements to the factory. -
xhrFields
An object of fieldName-fieldValue pairs to set on the native
XHR
object. For example, you can use it to set
withCredentials
to
true
for cross-domain requests if needed.123456
$.ajax({
url: a_cross_domain_url,
xhrFields: {
withCredentials: true
});
In jQuery 1.5, the
(version added: 1.5.1)
withCredentials
property was not propagated to the native
XHR
and thus CORS requests requiring it would ignore this flag. For this reason, we recommend using jQuery 1.5.1+ should you require the use of it.
-
accepts (default:
-
settingsA set of key/value pairs that configure the Ajax request. All settings are optional. A default can be set for any option with $.ajaxSetup().
The
$.ajax()
function underlies all Ajax requests sent by jQuery. It is often unnecessary to directly call this function, as several higher-level alternatives like
$.get()
and
.load()
are available and are easier to use. If less common options are required, though,
$.ajax()
can be used more flexibly.
At its simplest, the
$.ajax()
function can be called with no arguments:
Note: Default settings can be set globally by using the
$.ajaxSetup()
function.
This example, using no options, loads the contents of the current page, but does nothing with the result. To use the result, you can implement one of the callback functions.
The jqXHR Object
The jQuery XMLHttpRequest (jqXHR) object returned by
$.ajax()
as of jQuery 1.5 is a superset of the browser’s native XMLHttpRequest object. For example, it contains
responseText
and
responseXML
properties, as well as a
getResponseHeader()
method. When the transport mechanism is something other than XMLHttpRequest (for example, a script tag for a JSONP request) the
jqXHR
object simulates native XHR functionality where possible.
As of jQuery 1.5.1, the
jqXHR
object also contains the
overrideMimeType()
method (it was available in jQuery 1.4.x, as well, but was temporarily removed in jQuery 1.5). The
.overrideMimeType()
method may be used in the
beforeSend()
callback function, for example, to modify the response content-type header:
10 11 |
The jqXHR objects returned by
$.ajax()
as of jQuery 1.5 implement the Promise interface, giving them all the properties, methods, and behavior of a Promise (see Deferred object for more information). These methods take one or more function arguments that are called when the
$.ajax()
request terminates. This allows you to assign multiple callbacks on a single request, and even to assign callbacks after the request may have completed. (If the request is already complete, the callback is fired immediately.) Available Promise methods of the jqXHR object include:
-
jqXHR.done(function( data, textStatus, jqXHR ) {});
An alternative construct to the success callback option, refer to
deferred.done()
for implementation details. -
jqXHR.fail(function( jqXHR, textStatus, errorThrown ) {});
An alternative construct to the error callback option, the
.fail()
method replaces the deprecated
.error()
method. Refer to
deferred.fail()
for implementation details. -
jqXHR.always(function( data|jqXHR, textStatus, jqXHR|errorThrown ) { }); (added in jQuery 1.6)
An alternative construct to the complete callback option, the
.always()
method replaces the deprecated
.complete()
method.In response to a successful request, the function’s arguments are the same as those of
.done()
: data, textStatus, and the jqXHR object. For failed requests the arguments are the same as those of
.fail()
: the jqXHR object, textStatus, and errorThrown. Refer to
deferred.always()
for implementation details. -
jqXHR.then(function( data, textStatus, jqXHR ) {}, function( jqXHR, textStatus, errorThrown ) {});
Incorporates the functionality of the
.done()
and
.fail()
methods, allowing (as of jQuery 1.8) the underlying Promise to be manipulated. Refer to
deferred.then()
for implementation details.
Deprecation Notice: The
jqXHR.success()
,
jqXHR.error()
, and
jqXHR.complete()
callbacks are removed as of jQuery 3.0. You can use
jqXHR.done()
,
jqXHR.fail()
, and
jqXHR.always()
instead.
10 11 12 13 14 15 16 17 18 19 |
The
this
reference within all callbacks is the object in the
context
option passed to
$.ajax
in the settings; if
context
is not specified,
this
is a reference to the Ajax settings themselves.
For backward compatibility with
XMLHttpRequest
, a
jqXHR
object will expose the following properties and methods:
-
readyState
-
responseXML
and/or
responseText
when the underlying request responded with xml and/or text, respectively -
status
-
statusText
(may be an empty string in HTTP/2) -
abort( [ statusText ] )
-
getAllResponseHeaders()
as a string -
getResponseHeader( name )
-
overrideMimeType( mimeType )
-
setRequestHeader( name, value )
which departs from the standard by replacing the old value with the new one rather than concatenating the new value to the old one -
statusCode( callbacksByStatusCode )
No
onreadystatechange
mechanism is provided, however, since
done
,
fail
,
always
, and
statusCode
cover all conceivable requirements.
Callback Function Queues
The
beforeSend
,
error
,
dataFilter
,
success
and
complete
options all accept callback functions that are invoked at the appropriate times.
As of jQuery 1.5, the
fail
and
done
, and, as of jQuery 1.6,
always
callback hooks are first-in, first-out managed queues, allowing for more than one callback for each hook. See Deferred object methods, which are implemented internally for these
$.ajax()
callback hooks.
The callback hooks provided by
$.ajax()
are as follows:
-
beforeSend
callback option is invoked; it receives the
jqXHR
object and the
settings
object as parameters. -
error
callback option is invoked, if the request fails. It receives the
jqXHR
, a string indicating the error type, and an exception object if applicable. Some built-in errors will provide a string as the exception object: “abort”, “timeout”, “No Transport”. -
dataFilter
callback option is invoked immediately upon successful receipt of response data. It receives the returned data and the value of
dataType
, and must return the (possibly altered) data to pass on to
success
. -
success
callback option is invoked, if the request succeeds. It receives the returned data, a string containing the success code, and the
jqXHR
object. -
Promise callbacks —
.done()
,
.fail()
,
.always()
, and
.then()
— are invoked, in the order they are registered. -
complete
callback option fires, when the request finishes, whether in failure or success. It receives the
jqXHR
object, as well as a string containing the success or error code.
Data Types
Different types of response to
$.ajax()
call are subjected to different kinds of pre-processing before being passed to the success handler. The type of pre-processing depends by default upon the Content-Type of the response, but can be set explicitly using the
dataType
option. If the
dataType
option is provided, the Content-Type header of the response will be disregarded.
The available data types are
text
,
html
,
xml
,
json
,
jsonp
, and
script
.
If
text
or
html
is specified, no pre-processing occurs. The data is simply passed on to the success handler, and made available through the
responseText
property of the
jqXHR
object.
If
xml
is specified, the response is parsed using
jQuery.parseXML
before being passed, as an
XMLDocument
, to the success handler. The XML document is made available through the
responseXML
property of the
jqXHR
object.
If
json
is specified, the response is parsed using
jQuery.parseJSON
before being passed, as an object, to the success handler. The parsed JSON object is made available through the
responseJSON
property of the
jqXHR
object.
If
script
is specified,
$.ajax()
will execute the JavaScript that is received from the server before passing it on to the success handler as a string.
If
jsonp
is specified,
$.ajax()
will automatically append a query string parameter of (by default)
callback=?
to the URL. The
jsonp
and
jsonpCallback
properties of the settings passed to
$.ajax()
can be used to specify, respectively, the name of the query string parameter and the name of the JSONP callback function. The server should return valid JavaScript that passes the JSON response into the callback function.
$.ajax()
will execute the returned JavaScript, calling the JSONP callback function, before passing the JSON object contained in the response to the
$.ajax()
success handler.
For more information on JSONP, see the original post detailing its use.
Sending Data to the Server
By default, Ajax requests are sent using the GET HTTP method. If the POST method is required, the method can be specified by setting a value for the
type
option. This option affects how the contents of the
data
option are sent to the server. POST data will always be transmitted to the server using UTF-8 charset, per the W3C XMLHTTPRequest standard.
The
data
option can contain either a query string of the form
key1=value1&key2=value2
, or an object of the form
{key1: 'value1', key2: 'value2'}
. If the latter form is used, the data is converted into a query string using
jQuery.param()
before it is sent. This processing can be circumvented by setting
processData
to
false
. The processing might be undesirable if you wish to send an XML object to the server; in this case, change the
contentType
option from
application/x-www-form-urlencoded
to a more appropriate MIME type.
Advanced Options
The
global
option prevents handlers registered for the
ajaxSend
,
ajaxError
, and similar events from firing when this request would trigger them. This can be useful to, for example, suppress a loading indicator that was implemented with an
ajaxSend
handler if the requests are frequent and brief. With cross-domain script and JSONP requests, the global option is automatically set to
false
. See the descriptions of these methods below for more details.
If the server performs HTTP authentication before providing a response, the user name and password pair can be sent via the
username
and
password
options.
Ajax requests are time-limited, so errors can be caught and handled to provide a better user experience. Request timeouts are usually either left at their default or set as a global default using
$.ajaxSetup()
rather than being overridden for specific requests with the
timeout
option.
By default, requests are always issued, but the browser may serve results out of its cache. To disallow use of the cached results, set
cache
to
false
. To cause the request to report failure if the asset has not been modified since the last request, set
ifModified
to
true
.
The
scriptCharset
allows the character set to be explicitly specified for requests that use a
Reservation
ID | Name | Start Location | End Location |
---|
There are some input controls. The reservation to be updated will first be fetched from the API, and is shown on these input controls.
User will update the reservation by entering the updated values in these input controls, and clicking the button.
On clicking the button the reservation will be updated and the newly updated values are shown inside the HTML table.
Next add the following jQuery code to this page:
$(document).ready(function () { GetReservation(); function GetReservation() { let params = (new URL(document.location)).searchParams; let id = params.get("id"); $.ajax({ url: "https://localhost:44324/api/Reservation/" + id, type: "get", contentType: "application/json", success: function (result, status, xhr) { $("#Id").val(result["id"]); $("#Name").val(result["name"]); $("#StartLocation").val(result["startLocation"]); $("#EndLocation").val(result["endLocation"]); }, error: function (xhr, status, error) { console.log(xhr) } }); } $("#UpdateButton").click(function (e) { let params = (new URL(document.location)).searchParams; let id = params.get("id"); data = new FormData(); data.append("Id", $("#Id").val()); data.append("Name", $("#Name").val()); data.append("StartLocation", $("#StartLocation").val()); data.append("EndLocation", $("#EndLocation").val()); $.ajax({ url: "https://localhost:44324/api/Reservation", type: "put", data: data, processData: false, contentType: false, success: function (result, status, xhr) { var str = "" + result["id"] + " " + result["name"] + " " + result["startLocation"] + " " + result[ $("table tbody").append(str); $("#resultDiv").show(); }, error: function (xhr, status, error) { console.log(xhr) } }); }); });
The reservation id is send to this page in query string. To get this reservation id the following 2 lines of codes are used:
let params = (new URL(document.location)).searchParams; let id = params.get(“id”);
So the variable called id now has the reservation id.
I then make the Call to the GET Method of the API to fetch the reservation data of this particular id.
Check the URL of the API to see id is added to the end of it.
url: "https://localhost:44324/api/Reservation/" + id
Once I get the reservation data from the Web API I bind it to the input controls:
$(“#Id”).val(result[“id”]); $(“#Name”).val(result[“name”]); $(“#StartLocation”).val(result[“startLocation”]); $(“#EndLocation”).val(result[“endLocation”]);
Now when the UpdateButton is clicked the reservation gets updated. See the jQuery AJAX code which Calls the Web API’s PUT Method.
$.ajax({ url: "https://localhost:44324/api/Reservation", type: "put", data: data, processData: false, contentType: false, success: function (result, status, xhr) { var str = "" + result["id"] + " " + result["name"] + " " + result["startLocation"] + " " + result[ $("table tbody").append(str); $("#resultDiv").show(); }, error: function (xhr, status, error) { console.log(xhr) } });
Notice that I have put the processData and contentType values to false:
processData: false contentType: false
Also notice the I send the updated reservation data to the Web API PUT method in a FormData object.
data = new FormData(); data.append(“Id”, $(“#Id”).val()); data.append(“Name”, $(“#Name”).val()); data.append(“StartLocation”, $(“#StartLocation”).val()); data.append(“EndLocation”, $(“#EndLocation”).val());
The functionality is shown by the below video:
Now I will Call the HTTP PATCH method of Web API, this method is shown below. Note that the HTTP PATCH method is also used to update a reservation.
[HttpPatch("{id}")] public StatusCodeResult Patch(int id, [FromBody]JsonPatchDocument
patch) { //… }
Create a new HTML page called UpdateReservationPatch.html. Then add the following HTML to this page:
There are input controls where the user can put the updated reservation values, and a button which on clicking will make the Web API call to update the reservation.
Now add the following jQuery code to this page:
$(document).ready(function () { GetReservation(); function GetReservation() { let params = (new URL(document.location)).searchParams; let id = params.get(“id”); $.ajax({ url: “https://localhost:44324/api/Reservation/” + id, type: “get”, contentType: “application/json”, success: function (result, status, xhr) { $(“#Id”).val(result[“id”]); $(“#Name”).val(result[“name”]); $(“#StartLocation”).val(result[“startLocation”]); $(“#EndLocation”).val(result[“endLocation”]); }, error: function (xhr, status, error) { console.log(xhr) } }); } $(“#UpdateButton”).click(function (e) { let params = (new URL(document.location)).searchParams; let id = params.get(“id”); $.ajax({ url: “https://localhost:44324/api/Reservation/” + id, type: “patch”, contentType: “application/json”, data: JSON.stringify([ { op: “replace”, path: “Name”, value: $(“#Name”).val() }, { op: “replace”, path: “StartLocation”, value: $(“#StartLocation”).val() } ]), success: function (result, status, xhr) { window.location.href = “AllReservation.html”; }, error: function (xhr, status, error) { console.log(xhr) } }); }); });
The reservation id is sent to this page’s URL in query string. So the GetReservation() gets this id and fetches it’s data by making the API call with the GET Method.
The HTTP PATCH type of API request is made by the UpdateButton click’s code which is:
$(“#UpdateButton”).click(function (e) { let params = (new URL(document.location)).searchParams; let id = params.get(“id”); $.ajax({ url: “https://localhost:44324/api/Reservation/” + id, type: “patch”, contentType: “application/json”, data: JSON.stringify([ { op: “replace”, path: “Name”, value: $(“#Name”).val() }, { op: “replace”, path: “StartLocation”, value: $(“#StartLocation”).val() } ]), success: function (result, status, xhr) { window.location.href = “AllReservation.html”; }, error: function (xhr, status, error) { console.log(xhr) } }); });
Notice that I used the JSON.stringify() method to send a json to the Web API. This json contains 3 name/value pairs:
data: JSON.stringify([ { op: “replace”, path: “Name”, value: $(“#Name”).val() }, { op: “replace”, path: “StartLocation”, value: $(“#StartLocation”).val() } ])
Go to AllReservation.html page and change the URL for the edit icon to UpdateReservationPatch.html.
appendElement.append($("").html(""
Then check the functionality which is shown by the below video:
Here I will have to invoke the Web API GET method and pass id parameter to it. This method is shown bwlow.
[HttpGet(“{id}”)] public ActionResult
Get(int id) { if (id == 0) return BadRequest(“Value must be passed in the request body.”); return Ok(repository[id]); }
So, create a new HTML Page called GetReservation.html and add the following code to it:
C-Sharpcorner Member List
Now, press F5 to execute the project.
You will encounter the following errors in Developer Tools.
ERROR 1
- OPTIONS http://localhost:52044/api/member 405 (Method Not Allowed).
- Response to the preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost:50702' is therefore not allowed access.
To remove the above errors, the Web.Config file needs to be updated.
Update Web.Config file of your WebAPI Project with the following codes.
Now, press F5 to execute the project again.
ERROR 2
- OPTIONS http://localhost:52044/api/member 405 (Method Not Allowed)
- Failed to load http://localhost:52044/api/member: Response for preflight does not have HTTP ok status.
To remove the above errors, the Global.asax.cs file needs to be updated. Update the Global.asax.cs file of your WebAPI Project with the following codes.
- protected void Application_BeginRequest()
- if (Request.Headers.AllKeys.Contains("Origin") && Request.HttpMethod == "OPTIONS")
- Response.End();
- Response.Flush();
Now, you can see the developer tools in the output screen. You will get the perfect output in console log.
Now, you can see on the browser that your browser is ready with the following output.
OUTPUT