Delphi DLL

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. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, StringBuilder, Rest, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
jsonToken: HCkJsonObject;
rest: HCkRest;
bAutoReconnect: Boolean;
sbAuth: HCkStringBuilder;
responseBody: PWideChar;
json: HCkJsonObject;
numErrors: Integer;
i: Integer;

begin
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) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

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) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// 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);
Memo1.Lines.Add(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) then
  begin
    Memo1.Lines.Add('Request Header: ');
    Memo1.Lines.Add(CkRest__lastRequestHeader(rest));
    Memo1.Lines.Add('----');
    Memo1.Lines.Add('Response StatusCode = ' + IntToStr(CkRest_getResponseStatusCode(rest)));
    Memo1.Lines.Add('Response StatusLine: ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkRest__responseHeader(rest));
    Exit;
  end;

// 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 do
  begin

    CkJsonObject_putI(json,i);
    Memo1.Lines.Add('Message: ' + CkJsonObject__stringOf(json,'Fault.Error[i].Message'));
    Memo1.Lines.Add('Detail: ' + CkJsonObject__stringOf(json,'Fault.Error[i].Detail'));
    Memo1.Lines.Add('code: ' + CkJsonObject__stringOf(json,'Fault.Error[i].code'));
    Memo1.Lines.Add('----');
    i := i + 1;
  end;

// ------------------------------------------------------
// 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);

end;