Unicode C

Xero Download Attachment for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to download a particular attachment for a particular Xero item. Unicode C

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkBinDataW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttpW http;
    HCkJsonObjectW jsonToken;
    const wchar_t *url;
    HCkBinDataW bd;

    success = FALSE;

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttpW_Create();

    jsonToken = CkJsonObjectW_Create();
    success = CkJsonObjectW_LoadFile(jsonToken,L"qa_data/tokens/xero-access-token.json");
    if (success == FALSE) {
        wprintf(L"%s\n",CkJsonObjectW_lastErrorText(jsonToken));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(jsonToken);
        return;
    }

    CkHttpW_putAuthToken(http,CkJsonObjectW_stringOf(jsonToken,L"access_token"));

    // Replace the value here with an actual tenant ID obtained from this example:
    // Get Xero Tenant IDs
    CkHttpW_SetRequestHeader(http,L"Xero-tenant-id",L"83299b9e-5747-4a14-a18a-a6c94f824eb7");

    CkHttpW_putAccept(http,L"application/json");

    // The example to list Xero attachments shows how to get attachment information.
    // Here's a sample JSON response obtained form listing attachments:
    // Your application can get the AttachmentID's and filenames from it.

    // {
    //   "Id": "24bfbcb9-dec9-4d33-835c-8f165d776766",
    //   "Status": "OK",
    //   "ProviderName": "Chilkat2222",
    //   "DateTimeUTC": "\/Date(1587213296972)\/",
    //   "Attachments": [
    //     {
    //       "AttachmentID": "daf106e2-8634-4349-bfcc-86c1df0793b2",
    //       "FileName": "penguins.jpg",
    //       "Url": "https://api.xero.com/api.xro/2.0/Invoices/0032f627-3156-4d30-9b1c-4d3b994dc921/Attachments/penguins.jpg",
    //       "MimeType": "image/jpg",
    //       "ContentLength": 777835
    //     }
    //   ]
    // }

    url = L"https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/{$AttachmentId}";

    // Endpoint can be Invoices, Receipts, CreditNotes, PurchaseOrders, etc.
    CkHttpW_SetUrlVar(http,L"Endpoint",L"Invoices");

    // Guid is the ID of the item, such as the InvoiceID.
    CkHttpW_SetUrlVar(http,L"Guid",L"0032f627-3156-4d30-9b1c-4d3b994dc921");

    // AttachmentId is the ID of the particular attachment to be downloaded
    CkHttpW_SetUrlVar(http,L"AttachmentId",L"daf106e2-8634-4349-bfcc-86c1df0793b2");

    // Download the attachment data into bd.
    bd = CkBinDataW_Create();
    success = CkHttpW_QuickGetBd(http,url,bd);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(jsonToken);
        CkBinDataW_Dispose(bd);
        return;
    }

    wprintf(L"Response Status Code: %d\n",CkHttpW_getLastStatus(http));

    if (CkHttpW_getLastStatus(http) == 200) {
        // Success
        // Save to a file..
        success = CkBinDataW_WriteFile(bd,L"qa_output/penguines.jpg");
    }
    else {
        // Failed.  bd contains error information..
        wprintf(L"%s\n",CkBinDataW_getString(bd,L"utf-8"));
    }



    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(jsonToken);
    CkBinDataW_Dispose(bd);

    }