JavaScript

Send a Staged REST Request with a Binary Body

Demonstrates Rest.SendReqBd, which sends a request whose binary body is read from a BinData, then reads the response in separate steps.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

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 file paths are relative to the application's current working directory.  Absolute paths
//  may also be used.  Supply the paths appropriate to your own environment.

//  Send a request whose binary body is read from a BinData.
var bdBody = new CkBinData();
var bLoaded = bdBody.LoadFile("qa_data/image.png");
if (bLoaded !== true) {
    console.log("Failed to load the request body file.");
    return;
}

rest.AddHeader("Content-Type","image/png");

success = rest.SendReqBd("PUT","/api/images/1",bdBody);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

//  After sending, read the response status line and header fields.  The return value is the HTTP
//  status code, or -1 if no response was received.
var statusCode = rest.ReadResponseHeader();
if (statusCode < 0) {
    console.log(rest.LastErrorText);
    return;
}

console.log("Response status code: " + statusCode);

//  Read the response body as text.
var responseBody = rest.ReadRespBodyString();
if (rest.LastMethodSuccess == false) {
    console.log(rest.LastErrorText);
    return;
}

console.log(responseBody);