(Lianja) 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.

Chilkat Lianja Extension Download Chilkat Lianja Extension

// 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.

loRest = createobject("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..

// ------------------------------------------------------------------------------
lcFileID = "f042e9a3-a31d-4595-b8b3-6030ea6084bb"

loSbPath = createobject("CkStringBuilder")
loSbPath.Append("/files.xro/1.0/Files/{FileId}/Content")
lnNumReplaced = loSbPath.Replace("{FileId}",lcFileID)

loJpgData = createobject("CkBinData")
llSuccess = loRest.FullRequestNoBodyBd("GET",loSbPath.GetAsString(),loJpgData)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    release loSbPath
    release loJpgData
    return
endif

// 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 (loRest.ResponseStatusCode <> 200) then
    loSbErrorText = createobject("CkStringBuilder")
    loSbErrorText.AppendBd(loJpgData,"utf-8",0,0)
    ? loSbErrorText.GetAsString()
    ? "-- Failed."
    release loRest
    release loSbPath
    release loJpgData
    release loSbErrorText
    return
endif

// Save to a local file.
llSuccess = loJpgData.WriteFile("qa_output/xero_penguins.jpg")
if (llSuccess <> .T.) then
    ? "Failed to save to local file."
endif

? "Xero Get File was Successful."


release loRest
release loSbPath
release loJpgData
release loSbErrorText