(Tcl) Xero List Attachments for an Item (such as an Invoice)

Demonstrates how to get information about the attachments for a particular Xero item.

For more information, see https://developer.xero.com/documentation/api/attachments#GET

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/xero-access-token.json"]
if {$success == 0} then {
    puts [CkJsonObject_lastErrorText $jsonToken]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    exit
}

CkHttp_put_AuthToken $http [CkJsonObject_stringOf $jsonToken "access_token"]

# Replace the value here with an actual tenant ID obtained from this example:
# Get Xero Tenant IDs
CkHttp_SetRequestHeader $http "Xero-tenant-id" "83299b9e-5747-4a14-a18a-a6c94f824eb7"

CkHttp_put_Accept $http "application/json"

set url "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/"

# Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
CkHttp_SetUrlVar $http "Endpoint" "Invoices"

# Guid is the ID of the item, such as the InvoiceID.
CkHttp_SetUrlVar $http "Guid" "0032f627-3156-4d30-9b1c-4d3b994dc921"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "GET" $url]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    exit
}

puts "Response Status Code: [CkHttpResponse_get_StatusCode $resp]"

set jsonResponse [new_CkJsonObject]

CkJsonObject_Load $jsonResponse [CkHttpResponse_bodyStr $resp]
CkJsonObject_put_EmitCompact $jsonResponse 0
puts [CkJsonObject_emit $jsonResponse]

if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $jsonResponse
    exit
}

delete_CkHttpResponse $resp

# Sample response:
# 
# Use the this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

# {
#   "Id": "24bfbcb9-dec9-4d33-835c-8f165d776766",
#   "Status": "OK",
#   "ProviderName": "Chilkat2222",
#   "DateTimeUTC": "\/Date(1587213296972)\/",
#   "Attachments": [
#     {
#       "AttachmentID": "daf106e2-8634-4349-bfcc-86c1df0793b2",
#       "FileName": "penguins.jpg",
#       "Url": "https://api.xero.com/api.xro/2.0/Invoices/0032f627-3156-4d30-9b1c-4d3b994dc921/Attachments/penguins.jpg",
#       "MimeType": "image/jpg",
#       "ContentLength": 777835
#     }
#   ]
# }

set Id [CkJsonObject_stringOf $jsonResponse "Id"]
set Status [CkJsonObject_stringOf $jsonResponse "Status"]
set ProviderName [CkJsonObject_stringOf $jsonResponse "ProviderName"]
set DateTimeUTC [CkJsonObject_stringOf $jsonResponse "DateTimeUTC"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "Attachments"]
while {$i < $count_i} {
    CkJsonObject_put_I $jsonResponse $i
    set AttachmentID [CkJsonObject_stringOf $jsonResponse "Attachments[i].AttachmentID"]
    set FileName [CkJsonObject_stringOf $jsonResponse "Attachments[i].FileName"]
    set v_Url [CkJsonObject_stringOf $jsonResponse "Attachments[i].Url"]
    set MimeType [CkJsonObject_stringOf $jsonResponse "Attachments[i].MimeType"]
    set ContentLength [CkJsonObject_IntOf $jsonResponse "Attachments[i].ContentLength"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkJsonObject $jsonToken
delete_CkJsonObject $jsonResponse