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 <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttp http;
    HCkJsonObject jsonToken;
    const char *url;
    HCkHttpResponse resp;
    HCkJsonObject jsonResponse;
    const char *AttachmentID;
    const char *FileName;
    const char *v_Url;
    const char *MimeType;
    int ContentLength;
    const char *Id;
    const char *Status;
    const char *ProviderName;
    const char *DateTimeUTC;
    int i;
    int count_i;

    success = FALSE;

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

    http = CkHttp_Create();

    jsonToken = CkJsonObject_Create();
    success = CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/xero-access-token.json");
    if (success == FALSE) {
        printf("%s\n",CkJsonObject_lastErrorText(jsonToken));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(jsonToken);
        return;
    }

    CkHttp_putAuthToken(http,CkJsonObject_stringOf(jsonToken,"access_token"));

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

    CkHttp_putAccept(http,"application/json");

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

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

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

    resp = CkHttpResponse_Create();
    success = CkHttp_HttpNoBody(http,"GET",url,resp);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(jsonToken);
        CkHttpResponse_Dispose(resp);
        return;
    }

    printf("Response Status Code: %d\n",CkHttpResponse_getStatusCode(resp));

    jsonResponse = CkJsonObject_Create();
    CkJsonObject_Load(jsonResponse,CkHttpResponse_bodyStr(resp));
    CkJsonObject_putEmitCompact(jsonResponse,FALSE);
    printf("%s\n",CkJsonObject_emit(jsonResponse));

    if (CkHttpResponse_getStatusCode(resp) != 200) {
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(jsonToken);
        CkHttpResponse_Dispose(resp);
        CkJsonObject_Dispose(jsonResponse);
        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
    //     }
    //   ]
    // }

    Id = CkJsonObject_stringOf(jsonResponse,"Id");
    Status = CkJsonObject_stringOf(jsonResponse,"Status");
    ProviderName = CkJsonObject_stringOf(jsonResponse,"ProviderName");
    DateTimeUTC = CkJsonObject_stringOf(jsonResponse,"DateTimeUTC");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jsonResponse,"Attachments");
    while (i < count_i) {
        CkJsonObject_putI(jsonResponse,i);
        AttachmentID = CkJsonObject_stringOf(jsonResponse,"Attachments[i].AttachmentID");
        FileName = CkJsonObject_stringOf(jsonResponse,"Attachments[i].FileName");
        v_Url = CkJsonObject_stringOf(jsonResponse,"Attachments[i].Url");
        MimeType = CkJsonObject_stringOf(jsonResponse,"Attachments[i].MimeType");
        ContentLength = CkJsonObject_IntOf(jsonResponse,"Attachments[i].ContentLength");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(jsonToken);
    CkHttpResponse_Dispose(resp);
    CkJsonObject_Dispose(jsonResponse);

    }