Tcl

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.

Tcl

load ./chilkat.dll

set success 0

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

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

# ------------------------------------------------------------------------------
set fileID "f042e9a3-a31d-4595-b8b3-6030ea6084bb"

set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/files.xro/1.0/Files/{FileId}/Content"
set numReplaced [CkStringBuilder_Replace $sbPath "{FileId}" $fileID]

set jpgData [new_CkBinData]

set success [CkRest_FullRequestNoBodyBd $rest "GET" [CkStringBuilder_getAsString $sbPath] $jpgData]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkBinData $jpgData
    exit
}

# 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 {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    set sbErrorText [new_CkStringBuilder]

    CkStringBuilder_AppendBd $sbErrorText $jpgData "utf-8" 0 0
    puts [CkStringBuilder_getAsString $sbErrorText]
    puts "-- Failed."
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    delete_CkBinData $jpgData
    delete_CkStringBuilder $sbErrorText
    exit
}

# Save to a local file.
set success [CkBinData_WriteFile $jpgData "qa_output/xero_penguins.jpg"]
if {$success != 1} then {
    puts "Failed to save to local file."
}

puts "Xero Get File was Successful."

delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkBinData $jpgData
delete_CkStringBuilder $sbErrorText