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 <CkJsonObject.h>
#include <CkRest.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    bool 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"
    //  }

    CkJsonObject jsonToken;
    success = jsonToken.LoadFile("qa_data/tokens/qb-access-token.json");

    CkRest rest;

    //  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.
    bool bAutoReconnect = true;
    success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
    if (success != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbAuth;
    sbAuth.Append("Bearer ");
    sbAuth.Append(jsonToken.stringOf("access_token"));
    rest.put_Authorization(sbAuth.getAsString());

    rest.AddHeader("Accept","application/json");
    rest.put_AllowHeaderFolding(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.)
    const char *responseBody = rest.fullRequestNoBody("GET","/v3/company/123146096291789/employee/999?minorversion=45");
    if (rest.get_LastMethodSuccess() != true) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

    //  Load the JSON response into a JSON object for parsing.
    //  A sample JSON response is shown below.
    CkJsonObject json;
    json.Load(responseBody);
    json.put_EmitCompact(false);
    std::cout << json.emit() << "\r\n";

    //  A 400 response is what we'd expect if trying to query for a non-existent employee ID
    if (rest.get_ResponseStatusCode() != 400) {
        std::cout << "Request Header: " << "\r\n";
        std::cout << rest.lastRequestHeader() << "\r\n";
        std::cout << "----" << "\r\n";
        std::cout << "Response StatusCode = " << rest.get_ResponseStatusCode() << "\r\n";
        std::cout << "Response StatusLine: " << rest.responseStatusText() << "\r\n";
        std::cout << "Response Header:" << "\r\n";
        std::cout << rest.responseHeader() << "\r\n";
        return;
    }

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

        json.put_I(i);
        std::cout << "Message: " << json.stringOf("Fault.Error[i].Message") << "\r\n";
        std::cout << "Detail: " << json.stringOf("Fault.Error[i].Detail") << "\r\n";
        std::cout << "code: " << json.stringOf("Fault.Error[i].code") << "\r\n";
        std::cout << "----" << "\r\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"
    //  }
    }