Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Tcl Examples

ASN.1
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
Facebook
FileAccess
Firebase
GMail REST API
GeoOp
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Sheets
Gzip
HTML-to-XML/Text
HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)

Java KeyStore (JKS)
Jira
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
PayPal
Peoplevox
QuickBooks
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Shopify
Socket/SSL/TLS
Spider
Stream
Stripe
SugarCRM
Tar Archive
Twitter
Upload
VoiceBase
Walmart
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Xero
Zip
curl
eBay

 

 

 

(Tcl) Xero Get Attachment (Download a Xero Attachment)

Demonstrates how to get the content of an attachment in Xero.

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

Chilkat Tcl Extension Downloads

Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

#  --------------------------------------------------------------
#  First get a list of attachments for a given document (in this case a Receipt).

set endPoint "Receipts"
set receiptID "c4f40e59-c390-0001-caff-ce731c707d00"

set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "/api.xro/2.0/{Endpoint}/{Guid}/Attachments/"
set numReplaced [CkStringBuilder_Replace $sbPath "{Endpoint}" $endPoint]
set numReplaced [CkStringBuilder_Replace $sbPath "{Guid}" $receiptID]

set responseXml [CkRest_fullRequestNoBody $rest "GET" [CkStringBuilder_getAsString $sbPath]]
if {[expr [CkRest_get_LastMethodSuccess $rest] != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    exit
}

#  A 200 response is expected for actual success.
if {[expr [CkRest_get_ResponseStatusCode $rest] != 200]} then {
    puts "$responseXml"
    delete_CkRest $rest
    delete_CkStringBuilder $sbPath
    exit
}

#  Examine the response.
puts "$responseXml"

#  A sample response looks like this:

#  	<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
#  	  <Id>b235646f-34ac-4b15-90ce-d63267f7cd33</Id>
#  	  <Status>OK</Status>
#  	  <ProviderName>ChilkatPrivate</ProviderName>
#  	  <DateTimeUTC>2016-11-11T14:32:17.0908971Z</DateTimeUTC>
#  	  <Attachments>
#  	    <Attachment>
#  	      <AttachmentID>0edcddc8-325f-40c7-b950-8c71f14afc7c</AttachmentID>
#  	      <FileName>penguins.jpg</FileName>
#  	      <Url>http://api.xero.com/api.xro/2.0/Receipts/c4f40e59-c390-0001-caff-ce731c707d00/Attachments/penguins.jpg</Url>
#  	      <MimeType>image/jpg</MimeType>
#  	      <ContentLength>777835</ContentLength>
#  	    </Attachment>
#  	    <Attachment>
#  	      <AttachmentID>0adffdc8-325f-65c7-b950-4391f14af908</AttachmentID>
#  	      <FileName>starfish.jpg</FileName>
#  	      <Url>http://api.xero.com/api.xro/2.0/Receipts/c4f40e59-c390-0001-caff-ce731c707d00/Attachments/starfish.jpg</Url>
#  	      <MimeType>image/jpg</MimeType>
#  	      <ContentLength>24537</ContentLength>
#  	    </Attachment>
#  	  </Attachments>
#  	</Response>

set xml [new_CkXml]

CkXml_LoadXml $xml $responseXml

#  Iterate over the attachments and download each.
set numRecords [CkXml_NumChildrenAt $xml "Attachments"]
puts "Number of Attachments = $numRecords"

set sbSaveFilePath [new_CkStringBuilder]

set sbAttachmentPath [new_CkStringBuilder]

set attachmentData [new_CkBinData]

set i 0
while {[expr $i < $numRecords]} {
    CkXml_put_I $xml $i
    set attachmentID [CkXml_getChildContent $xml "Attachments|Attachment[i]|AttachmentID"]
    set filename [CkXml_getChildContent $xml "Attachments|Attachment[i]|FileName"]

    puts "AttachmentID: $attachmentID"
    puts "Filename: $filename"
    puts "----"

    #  Download this attachment.
    #  First build the path for this particular attachment by appending the FileName to the path used to get the list of attachments.
    [CkStringBuilder_Clear $sbAttachmentPath]
    [CkStringBuilder_AppendSb $sbAttachmentPath $sbPath]
    [CkStringBuilder_Append $sbAttachmentPath $filename]

    #  Send the GET request in one call, and then get the response in the next two.
    set success [CkRest_SendReqNoBody $rest "GET" [CkStringBuilder_getAsString $sbAttachmentPath]]
    if {[expr $success != 1]} then {
        puts [CkRest_lastErrorText $rest]
        delete_CkRest $rest
        delete_CkStringBuilder $sbPath
        delete_CkXml $xml
        delete_CkStringBuilder $sbSaveFilePath
        delete_CkStringBuilder $sbAttachmentPath
        delete_CkBinData $attachmentData
        exit
    }

    #  Get the response header.  If it's not a 200 success status code, then the response body does NOT contain
    #  the attachment data.
    set statusCode [CkRest_ReadResponseHeader $rest]
    if {[expr $statusCode == -1]} then {
        #  We didn't get any response..
        puts [CkRest_lastErrorText $rest]
        delete_CkRest $rest
        delete_CkStringBuilder $sbPath
        delete_CkXml $xml
        delete_CkStringBuilder $sbSaveFilePath
        delete_CkStringBuilder $sbAttachmentPath
        delete_CkBinData $attachmentData
        exit
    }

    if {[expr $statusCode != 200]} then {
        puts "Response Status: $statusCode"
        set responseBody [CkRest_readRespBodyString $rest]
        if {[expr [CkRest_get_LastMethodSuccess $rest] != 1]} then {
            puts "Failed to read the response body."
        }         else {
            puts "$responseBody"
        }

        puts "Failed."
        delete_CkRest $rest
        delete_CkStringBuilder $sbPath
        delete_CkXml $xml
        delete_CkStringBuilder $sbSaveFilePath
        delete_CkStringBuilder $sbAttachmentPath
        delete_CkBinData $attachmentData
        exit
    }

    #  OK, the response header indicates the attachment content is forthcoming...
    #  There are a few ways to get the response body. If it is a very large attachment, it can be streamed directly
    #  to a file.  We'll assume it's not, so we'll get the response into a BinData object, and then save it to a file.
    [CkBinData_Clear $attachmentData]
    set success [CkRest_ReadRespBd $rest $attachmentData]
    if {[expr $success != 1]} then {
        puts [CkRest_lastErrorText $rest]
        delete_CkRest $rest
        delete_CkStringBuilder $sbPath
        delete_CkXml $xml
        delete_CkStringBuilder $sbSaveFilePath
        delete_CkStringBuilder $sbAttachmentPath
        delete_CkBinData $attachmentData
        exit
    }

    #  Save the data to the file.
    [CkStringBuilder_SetString $sbSaveFilePath "qa_output/"]
    [CkStringBuilder_Append $sbSaveFilePath $filename]
    set success [CkBinData_WriteFile $attachmentData [CkStringBuilder_getAsString $sbSaveFilePath]]
    if {[expr $success != 1]} then {
        puts "Failed to save to output file."
    }     else {
        puts "Saved to [CkStringBuilder_getAsString $sbSaveFilePath]"
    }

    set i [expr $i + 1]
}

delete_CkRest $rest
delete_CkStringBuilder $sbPath
delete_CkXml $xml
delete_CkStringBuilder $sbSaveFilePath
delete_CkStringBuilder $sbAttachmentPath
delete_CkBinData $attachmentData

 

© 2000-2016 Chilkat Software, Inc. All Rights Reserved.