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
(Lianja) 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.
// 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. loRest = createobject("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). lcEndPoint = "Receipts" lcReceiptID = "c4f40e59-c390-0001-caff-ce731c707d00" loSbPath = createobject("CkStringBuilder") loSbPath.Append("/api.xro/2.0/{Endpoint}/{Guid}/Attachments/") lnNumReplaced = loSbPath.Replace("{Endpoint}",lcEndPoint) lnNumReplaced = loSbPath.Replace("{Guid}",lcReceiptID) lcResponseXml = loRest.FullRequestNoBody("GET",loSbPath.GetAsString()) if (loRest.LastMethodSuccess <> .T.) then ? loRest.LastErrorText release loRest release loSbPath return endif // A 200 response is expected for actual success. if (loRest.ResponseStatusCode <> 200) then ? lcResponseXml release loRest release loSbPath return endif // Examine the response. ? lcResponseXml // 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> loXml = createobject("CkXml") loXml.LoadXml(lcResponseXml) // Iterate over the attachments and download each. lnNumRecords = loXml.NumChildrenAt("Attachments") ? "Number of Attachments = " + str(lnNumRecords) loSbSaveFilePath = createobject("CkStringBuilder") loSbAttachmentPath = createobject("CkStringBuilder") loAttachmentData = createobject("CkBinData") i = 0 do while i < lnNumRecords loXml.I = i lcAttachmentID = loXml.GetChildContent("Attachments|Attachment[i]|AttachmentID") lcFilename = loXml.GetChildContent("Attachments|Attachment[i]|FileName") ? "AttachmentID: " + lcAttachmentID ? "Filename: " + lcFilename ? "----" // 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. loSbAttachmentPath.Clear() loSbAttachmentPath.AppendSb(loSbPath) loSbAttachmentPath.Append(lcFilename) // Send the GET request in one call, and then get the response in the next two. llSuccess = loRest.SendReqNoBody("GET",loSbAttachmentPath.GetAsString()) if (llSuccess <> .T.) then ? loRest.LastErrorText release loRest release loSbPath release loXml release loSbSaveFilePath release loSbAttachmentPath release loAttachmentData return endif // Get the response header. If it's not a 200 success status code, then the response body does NOT contain // the attachment data. lnStatusCode = loRest.ReadResponseHeader() if (lnStatusCode = -1) then // We didn't get any response.. ? loRest.LastErrorText release loRest release loSbPath release loXml release loSbSaveFilePath release loSbAttachmentPath release loAttachmentData return endif if (lnStatusCode <> 200) then ? "Response Status: " + str(lnStatusCode) lcResponseBody = loRest.ReadRespBodyString() if (loRest.LastMethodSuccess <> .T.) then ? "Failed to read the response body." else ? lcResponseBody endif ? "Failed." release loRest release loSbPath release loXml release loSbSaveFilePath release loSbAttachmentPath release loAttachmentData return endif // 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. loAttachmentData.Clear() llSuccess = loRest.ReadRespBd(loAttachmentData) if (llSuccess <> .T.) then ? loRest.LastErrorText release loRest release loSbPath release loXml release loSbSaveFilePath release loSbAttachmentPath release loAttachmentData return endif // Save the data to the file. loSbSaveFilePath.SetString("qa_output/") loSbSaveFilePath.Append(lcFilename) llSuccess = loAttachmentData.WriteFile(loSbSaveFilePath.GetAsString()) if (llSuccess <> .T.) then ? "Failed to save to output file." else ? "Saved to " + loSbSaveFilePath.GetAsString() endif i = i + 1 enddo release loRest release loSbPath release loXml release loSbSaveFilePath release loSbAttachmentPath release loAttachmentData |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.