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
(Swift 3,4,5...) 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.
func chilkatTest() { // 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. let rest = CkoRest()! var success: Bool // 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: String? = "Receipts" var receiptID: String? = "c4f40e59-c390-0001-caff-ce731c707d00" let sbPath = CkoStringBuilder()! sbPath.append("/api.xro/2.0/{Endpoint}/{Guid}/Attachments/") var numReplaced: Int = sbPath.replace("{Endpoint}", replacement: endPoint).intValue numReplaced = sbPath.replace("{Guid}", replacement: receiptID).intValue var responseXml: String? = rest.fullRequestNoBody("GET", uriPath: sbPath.getAsString()) if rest.lastMethodSuccess != true { print("\(rest.lastErrorText!)") return } // A 200 response is expected for actual success. if rest.responseStatusCode.intValue != 200 { print("\(responseXml!)") return } // Examine the response. print("\(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> let xml = CkoXml()! xml.load(responseXml) // Iterate over the attachments and download each. var numRecords: Int = xml.numChildren(at: "Attachments").intValue print("Number of Attachments = \(numRecords)") let sbSaveFilePath = CkoStringBuilder()! let sbAttachmentPath = CkoStringBuilder()! let attachmentData = CkoBinData()! var i: Int = 0 while i < numRecords { xml.i = i var attachmentID: String? = xml.getChildContent("Attachments|Attachment[i]|AttachmentID") var filename: String? = xml.getChildContent("Attachments|Attachment[i]|FileName") print("AttachmentID: \(attachmentID!)") print("Filename: \(filename!)") print("----") // 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", uriPath: sbAttachmentPath.getAsString()) if success != true { print("\(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: Int = rest.readResponseHeader().intValue if statusCode == -1 { // We didn't get any response.. print("\(rest.lastErrorText!)") return } if statusCode != 200 { print("Response Status: \(statusCode)") var responseBody: String? = rest.readRespBodyString() if rest.lastMethodSuccess != true { print("Failed to read the response body.") } else { print("\(responseBody!)") } print("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 { print("\(rest.lastErrorText!)") return } // Save the data to the file. sbSaveFilePath.setString("qa_output/") sbSaveFilePath.append(filename) success = attachmentData.writeFile(sbSaveFilePath.getAsString()) if success != true { print("Failed to save to output file.") } else { print("Saved to \(sbSaveFilePath.getAsString()!)") } i = i + 1 } } |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.