JavaScript

Send a Form-URL-Encoded REST Request

Demonstrates Rest.FullRequestFormUrlEncoded, which sends an application/x-www-form-urlencoded request. The body is built from the query parameters added to the object, and the response body is returned as text.

Background. For a form-url-encoded request the accumulated parameters become the request body rather than the URL query string. This matches the encoding used by HTML form POSTs.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

var rest = new CkRest();
var bTls = true;
var bAutoReconnect = true;
success = rest.Connect("example.com",443,bTls,bAutoReconnect);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

//  The application/x-www-form-urlencoded body is built from the query parameters added to the object.
rest.AddQueryParam("username","alice");
rest.AddQueryParam("action","login");

//  Send the form-url-encoded request.  The parameters become the request body rather than the URL
//  query string.
var responseText = rest.FullRequestFormUrlEncoded("POST","/api/login");
if (rest.LastMethodSuccess == false) {
    console.log(rest.LastErrorText);
    return;
}

console.log(responseText);