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
(C) 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 <C_CkRest.h> #include <C_CkStringBuilder.h> #include <C_CkXml.h> #include <C_CkBinData.h> void ChilkatSample(void) { HCkRest rest; BOOL success; const char *endPoint; const char *receiptID; HCkStringBuilder sbPath; int numReplaced; const char *responseXml; HCkXml xml; int numRecords; HCkStringBuilder sbSaveFilePath; HCkStringBuilder sbAttachmentPath; HCkBinData attachmentData; int i; const char *attachmentID; const char *filename; int statusCode; const char *responseBody; // 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. rest = CkRest_Create(); // 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). endPoint = "Receipts"; receiptID = "c4f40e59-c390-0001-caff-ce731c707d00"; sbPath = CkStringBuilder_Create(); CkStringBuilder_Append(sbPath,"/api.xro/2.0/{Endpoint}/{Guid}/Attachments/"); numReplaced = CkStringBuilder_Replace(sbPath,"{Endpoint}",endPoint); numReplaced = CkStringBuilder_Replace(sbPath,"{Guid}",receiptID); responseXml = CkRest_fullRequestNoBody(rest,"GET",CkStringBuilder_getAsString(sbPath)); if (CkRest_getLastMethodSuccess(rest) != TRUE) { printf("%s\n",CkRest_lastErrorText(rest)); CkRest_Dispose(rest); CkStringBuilder_Dispose(sbPath); return; } // A 200 response is expected for actual success. if (CkRest_getResponseStatusCode(rest) != 200) { printf("%s\n",responseXml); CkRest_Dispose(rest); CkStringBuilder_Dispose(sbPath); return; } // Examine the response. printf("%s\n",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> xml = CkXml_Create(); CkXml_LoadXml(xml,responseXml); // Iterate over the attachments and download each. numRecords = CkXml_NumChildrenAt(xml,"Attachments"); printf("Number of Attachments = %d\n",numRecords); sbSaveFilePath = CkStringBuilder_Create(); sbAttachmentPath = CkStringBuilder_Create(); attachmentData = CkBinData_Create(); i = 0; while (i < numRecords) { CkXml_putI(xml,i); attachmentID = CkXml_getChildContent(xml,"Attachments|Attachment[i]|AttachmentID"); filename = CkXml_getChildContent(xml,"Attachments|Attachment[i]|FileName"); printf("AttachmentID: %s\n",attachmentID); printf("Filename: %s\n",filename); printf("----\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. 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. success = CkRest_SendReqNoBody(rest,"GET",CkStringBuilder_getAsString(sbAttachmentPath)); if (success != TRUE) { printf("%s\n",CkRest_lastErrorText(rest)); CkRest_Dispose(rest); CkStringBuilder_Dispose(sbPath); CkXml_Dispose(xml); CkStringBuilder_Dispose(sbSaveFilePath); CkStringBuilder_Dispose(sbAttachmentPath); CkBinData_Dispose(attachmentData); return; } // Get the response header. If it's not a 200 success status code, then the response body does NOT contain // the attachment data. statusCode = CkRest_ReadResponseHeader(rest); if (statusCode == -1) { // We didn't get any response.. printf("%s\n",CkRest_lastErrorText(rest)); CkRest_Dispose(rest); CkStringBuilder_Dispose(sbPath); CkXml_Dispose(xml); CkStringBuilder_Dispose(sbSaveFilePath); CkStringBuilder_Dispose(sbAttachmentPath); CkBinData_Dispose(attachmentData); return; } if (statusCode != 200) { printf("Response Status: %d\n",statusCode); responseBody = CkRest_readRespBodyString(rest); if (CkRest_getLastMethodSuccess(rest) != TRUE) { printf("Failed to read the response body.\n"); } else { printf("%s\n",responseBody); } printf("Failed.\n"); CkRest_Dispose(rest); CkStringBuilder_Dispose(sbPath); CkXml_Dispose(xml); CkStringBuilder_Dispose(sbSaveFilePath); CkStringBuilder_Dispose(sbAttachmentPath); CkBinData_Dispose(attachmentData); 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. CkBinData_Clear(attachmentData); success = CkRest_ReadRespBd(rest,attachmentData); if (success != TRUE) { printf("%s\n",CkRest_lastErrorText(rest)); CkRest_Dispose(rest); CkStringBuilder_Dispose(sbPath); CkXml_Dispose(xml); CkStringBuilder_Dispose(sbSaveFilePath); CkStringBuilder_Dispose(sbAttachmentPath); CkBinData_Dispose(attachmentData); return; } // Save the data to the file. CkStringBuilder_SetString(sbSaveFilePath,"qa_output/"); CkStringBuilder_Append(sbSaveFilePath,filename); success = CkBinData_WriteFile(attachmentData,CkStringBuilder_getAsString(sbSaveFilePath)); if (success != TRUE) { printf("Failed to save to output file.\n"); } else { printf("Saved to %s\n",CkStringBuilder_getAsString(sbSaveFilePath)); } i = i + 1; } CkRest_Dispose(rest); CkStringBuilder_Dispose(sbPath); CkXml_Dispose(xml); CkStringBuilder_Dispose(sbSaveFilePath); CkStringBuilder_Dispose(sbAttachmentPath); CkBinData_Dispose(attachmentData); } |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.