JavaScript

Examine HTTP Response Status Code and Text

See more REST Examples

Demonstrates how to examine the HTTP response status code and text when using the REST object. JavaScript

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

var rest = new CkRest();

// We're going to check https://authenticationtest.com/HTTPAuth/
var bTls = true;
var port = 443;
var bAutoReconnect = true;
success = rest.Connect("authenticationtest.com",port,bTls,bAutoReconnect);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

// Send a GET request
var responseText = rest.FullRequestNoBody("GET","/HTTPAuth/");
if (rest.LastMethodSuccess !== true) {
    console.log(rest.LastErrorText);
    return;
}

// The start line of an HTTP response, called the status line, contains the following information:
// 
//     The protocol version, usually HTTP/1.1.
//     A status code, indicating success or failure of the request. Common status codes are 200, 404, or 302
//     A status text. A brief, purely informational, textual description of the status code to help a human understand the HTTP message.
// 
// A typical status line looks like: HTTP/1.1 404 Not Found.

// The ResponseStatusCode property contains the integer response code:
console.log("Response status code = " + rest.ResponseStatusCode);

// The ResponseStatusText property contains the text (if any) that follows the status code on the status line.
console.log("Response status text = " + rest.ResponseStatusText);

// In this case, the sample output is:
// 
// Response status code = 401
// Response status text = Unauthorized