Chilkat HOME Android™ Classic ASP C C++ C# Mono C# .NET Core C# C# UWP/WinRT DataFlex Delphi ActiveX Delphi DLL Visual FoxPro Java Lianja MFC Objective-C Perl PHP ActiveX PHP Extension PowerBuilder PowerShell PureBasic CkPython Chilkat2-Python Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ Visual Basic 6.0 VB.NET VB.NET UWP/WinRT VBScript Xojo Plugin Node.js Excel Go
(MFC) 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.
#include <CkRest.h> #include <CkStringBuilder.h> #include <CkXml.h> #include <CkBinData.h> void ChilkatSample(void) { CkString strOut; // 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. CkRest rest; bool 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). const char *endPoint = "Receipts"; const char *receiptID = "c4f40e59-c390-0001-caff-ce731c707d00"; CkStringBuilder sbPath; sbPath.Append("/api.xro/2.0/{Endpoint}/{Guid}/Attachments/"); int numReplaced = sbPath.Replace("{Endpoint}",endPoint); numReplaced = sbPath.Replace("{Guid}",receiptID); const char *responseXml = rest.fullRequestNoBody("GET",sbPath.getAsString()); if (rest.get_LastMethodSuccess() != true) { strOut.append(rest.lastErrorText()); strOut.append("\r\n"); SetDlgItemText(IDC_EDIT1,strOut.getUnicode()); return; } // A 200 response is expected for actual success. if (rest.get_ResponseStatusCode() != 200) { strOut.append(responseXml); strOut.append("\r\n"); SetDlgItemText(IDC_EDIT1,strOut.getUnicode()); return; } // Examine the response. strOut.append(responseXml); strOut.append("\r\n"); // 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> CkXml xml; xml.LoadXml(responseXml); // Iterate over the attachments and download each. int numRecords = xml.NumChildrenAt("Attachments"); strOut.append("Number of Attachments = "); strOut.appendInt(numRecords); strOut.append("\r\n"); CkStringBuilder sbSaveFilePath; CkStringBuilder sbAttachmentPath; CkBinData attachmentData; int i = 0; while (i < numRecords) { xml.put_I(i); const char *attachmentID = xml.getChildContent("Attachments|Attachment[i]|AttachmentID"); const char *filename = xml.getChildContent("Attachments|Attachment[i]|FileName"); strOut.append("AttachmentID: "); strOut.append(attachmentID); strOut.append("\r\n"); strOut.append("Filename: "); strOut.append(filename); strOut.append("\r\n"); strOut.append("----"); strOut.append("\r\n"); // 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) { strOut.append(rest.lastErrorText()); strOut.append("\r\n"); SetDlgItemText(IDC_EDIT1,strOut.getUnicode()); return; } // Get the response header. If it's not a 200 success status code, then the response body does NOT contain // the attachment data. int statusCode = rest.ReadResponseHeader(); if (statusCode == -1) { // We didn't get any response.. strOut.append(rest.lastErrorText()); strOut.append("\r\n"); SetDlgItemText(IDC_EDIT1,strOut.getUnicode()); return; } if (statusCode != 200) { strOut.append("Response Status: "); strOut.appendInt(statusCode); strOut.append("\r\n"); const char *responseBody = rest.readRespBodyString(); if (rest.get_LastMethodSuccess() != true) { strOut.append("Failed to read the response body."); strOut.append("\r\n"); } else { strOut.append(responseBody); strOut.append("\r\n"); } strOut.append("Failed."); strOut.append("\r\n"); SetDlgItemText(IDC_EDIT1,strOut.getUnicode()); 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) { strOut.append(rest.lastErrorText()); strOut.append("\r\n"); SetDlgItemText(IDC_EDIT1,strOut.getUnicode()); return; } // Save the data to the file. sbSaveFilePath.SetString("qa_output/"); sbSaveFilePath.Append(filename); success = attachmentData.WriteFile(sbSaveFilePath.getAsString()); if (success != true) { strOut.append("Failed to save to output file."); strOut.append("\r\n"); } else { strOut.append("Saved to "); strOut.append(sbSaveFilePath.getAsString()); strOut.append("\r\n"); } i = i + 1; } SetDlgItemText(IDC_EDIT1,strOut.getUnicode()); } |
© 2000-2022 Chilkat Software, Inc. All Rights Reserved.