Chilkat HOME .NET Core C# Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi ActiveX Delphi DLL Go Java Lianja Mono C# Node.js Objective-C PHP ActiveX PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(Node.js) 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.
var os = require('os'); if (os.platform() == 'win32') { if (os.arch() == 'ia32') { var chilkat = require('@chilkat/ck-node21-win-ia32'); } else { var chilkat = require('@chilkat/ck-node21-win64'); } } else if (os.platform() == 'linux') { if (os.arch() == 'arm') { var chilkat = require('@chilkat/ck-node21-arm'); } else if (os.arch() == 'x86') { var chilkat = require('@chilkat/ck-node21-linux32'); } else { var chilkat = require('@chilkat/ck-node21-linux64'); } } else if (os.platform() == 'darwin') { if (os.arch() == 'arm64') { var chilkat = require('@chilkat/ck-node21-mac-m1'); } else { var chilkat = require('@chilkat/ck-node21-macosx'); } } function chilkatExample() { // 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 chilkat.Rest(); var success; // 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). var endPoint = "Receipts"; var receiptID = "c4f40e59-c390-0001-caff-ce731c707d00"; var sbPath = new chilkat.StringBuilder(); sbPath.Append("/api.xro/2.0/{Endpoint}/{Guid}/Attachments/"); var numReplaced = sbPath.Replace("{Endpoint}",endPoint); numReplaced = sbPath.Replace("{Guid}",receiptID); var responseXml = rest.FullRequestNoBody("GET",sbPath.GetAsString()); if (rest.LastMethodSuccess !== true) { console.log(rest.LastErrorText); return; } // A 200 response is expected for actual success. if (rest.ResponseStatusCode !== 200) { console.log(responseXml); return; } // Examine the response. console.log(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> var xml = new chilkat.Xml(); xml.LoadXml(responseXml); // Iterate over the attachments and download each. var numRecords = xml.NumChildrenAt("Attachments"); console.log("Number of Attachments = " + numRecords); var sbSaveFilePath = new chilkat.StringBuilder(); var sbAttachmentPath = new chilkat.StringBuilder(); var attachmentData = new chilkat.BinData(); var i = 0; while (i < numRecords) { xml.I = i; var attachmentID = xml.GetChildContent("Attachments|Attachment[i]|AttachmentID"); var filename = xml.GetChildContent("Attachments|Attachment[i]|FileName"); console.log("AttachmentID: " + attachmentID); console.log("Filename: " + filename); console.log("----"); // 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. sbAttachmentPath.Clear(); sbAttachmentPath.AppendSb(sbPath); sbAttachmentPath.Append(filename); // Send the GET request in one call, and then get the response in the next two. success = rest.SendReqNoBody("GET",sbAttachmentPath.GetAsString()); if (success !== true) { console.log(rest.LastErrorText); return; } // Get the response header. If it's not a 200 success status code, then the response body does NOT contain // the attachment data. var statusCode = rest.ReadResponseHeader(); if (statusCode == -1) { // We didn't get any response.. console.log(rest.LastErrorText); return; } if (statusCode !== 200) { console.log("Response Status: " + statusCode); var responseBody = rest.ReadRespBodyString(); if (rest.LastMethodSuccess !== true) { console.log("Failed to read the response body."); } else { console.log(responseBody); } console.log("Failed."); return; } // 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. attachmentData.Clear(); success = rest.ReadRespBd(attachmentData); if (success !== true) { console.log(rest.LastErrorText); return; } // Save the data to the file. sbSaveFilePath.SetString("qa_output/"); sbSaveFilePath.Append(filename); success = attachmentData.WriteFile(sbSaveFilePath.GetAsString()); if (success !== true) { console.log("Failed to save to output file."); } else { console.log("Saved to " + sbSaveFilePath.GetAsString()); } i = i+1; } } chilkatExample(); |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.