C++

Xero List Attachments for an Item (such as an Invoice)

See more Xero Examples

Demonstrates how to get information about the attachments for a particular Xero item. C++

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkHttp http;

    CkJsonObject jsonToken;
    success = jsonToken.LoadFile("qa_data/tokens/xero-access-token.json");
    if (success == false) {
        std::cout << jsonToken.lastErrorText() << "\r\n";
        return;
    }

    http.put_AuthToken(jsonToken.stringOf("access_token"));

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

    http.put_Accept("application/json");

    const char *url = "https://api.xero.com/api.xro/2.0/{$Endpoint}/{$Guid}/Attachments/";

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

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

    CkHttpResponse resp;
    success = http.HttpNoBody("GET",url,resp);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    std::cout << "Response Status Code: " << resp.get_StatusCode() << "\r\n";

    CkJsonObject jsonResponse;
    jsonResponse.Load(resp.bodyStr());
    jsonResponse.put_EmitCompact(false);
    std::cout << jsonResponse.emit() << "\r\n";

    if (resp.get_StatusCode() != 200) {
        std::cout << "Failed." << "\r\n";
        return;
    }

    //  Sample response:
    //  
    //  Use the this online tool to generate parsing code from sample JSON: 
    //  Generate Parsing Code from JSON

    //  {
    //    "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
    //      }
    //    ]
    //  }

    const char *AttachmentID = 0;
    const char *FileName = 0;
    const char *v_Url = 0;
    const char *MimeType = 0;
    int ContentLength;

    const char *Id = jsonResponse.stringOf("Id");
    const char *Status = jsonResponse.stringOf("Status");
    const char *ProviderName = jsonResponse.stringOf("ProviderName");
    const char *DateTimeUTC = jsonResponse.stringOf("DateTimeUTC");
    int i = 0;
    int count_i = jsonResponse.SizeOfArray("Attachments");
    while (i < count_i) {
        jsonResponse.put_I(i);
        AttachmentID = jsonResponse.stringOf("Attachments[i].AttachmentID");
        FileName = jsonResponse.stringOf("Attachments[i].FileName");
        v_Url = jsonResponse.stringOf("Attachments[i].Url");
        MimeType = jsonResponse.stringOf("Attachments[i].MimeType");
        ContentLength = jsonResponse.IntOf("Attachments[i].ContentLength");
        i = i + 1;
    }
    }