Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

C Web API Examples

Primary Categories

CardConnect
Facebook
GeoOp
Jira
PayPal
Peoplevox
QuickBooks

Shopify
Stripe
SugarCRM
Twitter
VoiceBase
Walmart
Xero
eBay
effectconnect

 

 

 

(C) QuickBooks - Read an Employee (with Error Response)

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

Chilkat C/C++ Library Downloads

MS Visual C/C++

Linux/CentOS C/C++

Alpine Linux C/C++

MAC OS X C/C++

armhf/aarch64 C/C++

C++ Builder

iOS C/C++

Android C/C++

Win Mobile 5.0/Pocket PC 2003

Solaris C/C++

FreeBSD C/C++

OpenBSD C/C++

MinGW C/C++

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

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

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

    // This example also assumes an OAuth1 access token was previously fetched.
    // and saved in a JSON file.  See the Chilkat online examples at example-code.com
    // for Quickbooks OAuth1 examples (in the Quickbooks and OAuth1 categories)
    // 

    // First get our previously obtained access token.
    jsonToken = CkJsonObject_Create();
    success = CkJsonObject_LoadFile(jsonToken,"qa_data/tokens/quickbooks.json");

    oauth1 = CkOAuth1_Create();
    CkOAuth1_putConsumerKey(oauth1,"QUICKBOOKS_CONSUMER_KEY");
    CkOAuth1_putConsumerSecret(oauth1,"QUICKBOOKS_CONSUMER_SECRET");
    CkOAuth1_putToken(oauth1,CkJsonObject_stringOf(jsonToken,"oauth_token"));
    CkOAuth1_putTokenSecret(oauth1,CkJsonObject_stringOf(jsonToken,"oauth_token_secret"));

    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);
        CkOAuth1_Dispose(oauth1);
        CkRest_Dispose(rest);
        return;
    }

    CkRest_SetAuthOAuth1(rest,oauth1,FALSE);

    // The company ID is the realmId
    sbPath = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPath,"/v3/company/<companyID>/employee/<employeeID>");
    numReplacements = CkStringBuilder_Replace(sbPath,"<companyID>",CkJsonObject_stringOf(jsonToken,"realmId"));
    // Assume we already know that we want to read the employee whose Id = 98.
    // We know this employee was made inactive, and we should get an error response.
    numReplacements = CkStringBuilder_Replace(sbPath,"<employeeID>","98");

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

    responseBody = CkRest_fullRequestNoBody(rest,"GET",CkStringBuilder_getAsString(sbPath));
    if (CkRest_getLastMethodSuccess(rest) != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkJsonObject_Dispose(jsonToken);
        CkOAuth1_Dispose(oauth1);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbPath);
        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 an inactive employee...
    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);
        CkOAuth1_Dispose(oauth1);
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbPath);
        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": "2016-10-25T14:56:37.335-07:00"
    // }
    // 


    CkJsonObject_Dispose(jsonToken);
    CkOAuth1_Dispose(oauth1);
    CkRest_Dispose(rest);
    CkStringBuilder_Dispose(sbPath);
    CkJsonObject_Dispose(json);

    }

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.