C

QuickBooks - Read an Employee (with Error Response)

See more QuickBooks Examples

Demonstrates how to fetch the information for a specific Quickbooks employee, but tries to fetch using an invalid employee id. Shows the error response and how to parse it. C

#include <C_CkJsonObject.h>
#include <C_CkRest.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkJsonObject jsonToken;
    HCkRest rest;
    BOOL bAutoReconnect;
    HCkStringBuilder sbAuth;
    const char *responseBody;
    HCkJsonObject json;
    int numErrors;
    int i;

    success = FALSE;

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

    // Get our previously obtained OAuth2 access token, which should contain JSON like this:
    // {
    //   "expires_in": 3600,
    //   "x_refresh_token_expires_in": 8726400,
    //   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
    //   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
    //   "token_type": "bearer"
    // }

    jsonToken = CkJsonObject_Create();
    success = CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/qb-access-token.json");

    rest = CkRest_Create();

    // Connect using TLS.
    // A single REST object, once connected, can be used for many Quickbooks REST API calls.
    // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
    // then it will be automatically re-established as needed.
    bAutoReconnect = TRUE;
    success = CkRest_Connect(rest,"sandbox-quickbooks.api.intuit.com",443,TRUE,bAutoReconnect);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkJsonObject_Dispose(jsonToken);
        CkRest_Dispose(rest);
        return;
    }

    sbAuth = CkStringBuilder_Create();
    CkStringBuilder_Append(sbAuth,"Bearer ");
    CkStringBuilder_Append(sbAuth,CkJsonObject_stringOf(jsonToken,"access_token"));
    CkRest_putAuthorization(rest,CkStringBuilder_getAsString(sbAuth));

    CkRest_AddHeader(rest,"Accept","application/json");
    CkRest_putAllowHeaderFolding(rest,FALSE);

    // The company ID is 123146096291789
    // The employee ID is 999  (There is no employee with this ID and we should get a 400 response code w/ a response body indicating the error.)
    responseBody = CkRest_fullRequestNoBody(rest,"GET","/v3/company/123146096291789/employee/999?minorversion=45");
    if (CkRest_getLastMethodSuccess(rest) != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkJsonObject_Dispose(jsonToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbAuth);
        return;
    }

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    json = CkJsonObject_Create();
    CkJsonObject_Load(json,responseBody);
    CkJsonObject_putEmitCompact(json,FALSE);
    printf("%s\n",CkJsonObject_emit(json));

    // A 400 response is what we'd expect if trying to query for a non-existent employee ID
    if (CkRest_getResponseStatusCode(rest) != 400) {
        printf("Request Header: \n");
        printf("%s\n",CkRest_lastRequestHeader(rest));
        printf("----\n");
        printf("Response StatusCode = %d\n",CkRest_getResponseStatusCode(rest));
        printf("Response StatusLine: %s\n",CkRest_responseStatusText(rest));
        printf("Response Header:\n");
        printf("%s\n",CkRest_responseHeader(rest));
        CkJsonObject_Dispose(jsonToken);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbAuth);
        CkJsonObject_Dispose(json);
        return;
    }

    // If we got here, the response status code was 400..
    // Iterate over the errors..
    numErrors = CkJsonObject_SizeOfArray(json,"Fault.Error");
    i = 0;
    while (i < numErrors) {

        CkJsonObject_putI(json,i);
        printf("Message: %s\n",CkJsonObject_stringOf(json,"Fault.Error[i].Message"));
        printf("Detail: %s\n",CkJsonObject_stringOf(json,"Fault.Error[i].Detail"));
        printf("code: %s\n",CkJsonObject_stringOf(json,"Fault.Error[i].code"));
        printf("----\n");
        i = i + 1;
    }

    // ------------------------------------------------------
    // The JSON error response looks like this:

    // {
    //   "Fault": {
    //     "Error": [
    //       {
    //         "Message": "Object Not Found",
    //         "Detail": "Object Not Found : Something you're trying to use has been made inactive. Check the fields with accounts, customers, items, vendors or employees.",
    //         "code": "610",
    //         "element": ""
    //       }
    //     ],
    //     "type": "ValidationFault"
    //   },
    //   "time": "2020-03-07T10:21:19.089-08:00"
    // }


    CkJsonObject_Dispose(jsonToken);
    CkRest_Dispose(rest);
    CkStringBuilder_Dispose(sbAuth);
    CkJsonObject_Dispose(json);

    }