JavaScript

Send a REST Request with a Binary Body

Demonstrates Rest.FullRequestBd, which sends a complete request whose binary body is read from a BinData and stores the text response body in a StringBuilder.

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. FullRequestBd is used when the request payload is binary, such as an image or other file, while the response is textual (for example a JSON acknowledgement).

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.

//  FullRequestBd sends a request whose binary body is read from a BinData and stores the text
//  response body in a StringBuilder.
var bdRequest = new CkBinData();
var bLoaded = bdRequest.LoadFile("qa_data/image.png");
if (bLoaded !== true) {
    console.log("Failed to load the request body file.");
    return;
}

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

var sbResponse = new CkStringBuilder();
success = rest.FullRequestBd("PUT","/api/images/1",bdRequest,sbResponse);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

var responseText = sbResponse.GetAsString();
if (sbResponse.LastMethodSuccess == false) {
    console.log(sbResponse.LastErrorText);
    return;
}

console.log(responseText);