(JavaScript) Xero Get File Content (Files API)

Demonstrates how to download the content of a Xero file.

Note: This example requires Chilkat v9.5.0.64 or greater.

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.

var success = false;

// Note: Requires Chilkat v9.5.0.64 or greater.

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

var rest = new CkRest();

// Before sending REST API calls, the REST object needs to be
// initialized for OAuth1.
// See Xero 2-Legged OAuth1 Setup for sample code.

// Assuming the REST object's OAuth1 authenticator is setup, and the initial
// connection was made, we may now send REST HTTP requests..

// ------------------------------------------------------------------------------
var fileID = "f042e9a3-a31d-4595-b8b3-6030ea6084bb";

var sbPath = new CkStringBuilder();
sbPath.Append("/files.xro/1.0/Files/{FileId}/Content");
var numReplaced = sbPath.Replace("{FileId}",fileID);

var jpgData = new CkBinData();
success = rest.FullRequestNoBodyBd("GET",sbPath.GetAsString(),jpgData);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

// A 200 response is expected for actual success.
// If we don't get a 200 response, then the response body was not actually
// the file data, but it was text containing error information.
if (rest.ResponseStatusCode !== 200) {
    var sbErrorText = new CkStringBuilder();
    sbErrorText.AppendBd(jpgData,"utf-8",0,0);
    console.log(sbErrorText.GetAsString());
    console.log("-- Failed.");
    return;
}

// Save to a local file.
success = jpgData.WriteFile("qa_output/xero_penguins.jpg");
if (success !== true) {
    console.log("Failed to save to local file.");
}

console.log("Xero Get File was Successful.");