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

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.

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#read-an-employee

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var 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"
// }

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

var rest = new CkRest();

// 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.
var bAutoReconnect = true;
success = rest.Connect("sandbox-quickbooks.api.intuit.com",443,true,bAutoReconnect);
if (success !== true) {
    console.log(rest.LastErrorText);
    return;
}

var sbAuth = new CkStringBuilder();
sbAuth.Append("Bearer ");
sbAuth.Append(jsonToken.StringOf("access_token"));
rest.Authorization = sbAuth.GetAsString();

rest.AddHeader("Accept","application/json");
rest.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.)
var responseBody = rest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/999?minorversion=45");
if (rest.LastMethodSuccess !== true) {
    console.log(rest.LastErrorText);
    return;
}

// Load the JSON response into a JSON object for parsing.
// A sample JSON response is shown below.
var json = new CkJsonObject();
json.Load(responseBody);
json.EmitCompact = false;
console.log(json.Emit());

// A 400 response is what we'd expect if trying to query for a non-existent employee ID
if (rest.ResponseStatusCode !== 400) {
    console.log("Request Header: ");
    console.log(rest.LastRequestHeader);
    console.log("----");
    console.log("Response StatusCode = " + rest.ResponseStatusCode);
    console.log("Response StatusLine: " + rest.ResponseStatusText);
    console.log("Response Header:");
    console.log(rest.ResponseHeader);
    return;
}

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

    json.I = i;
    console.log("Message: " + json.StringOf("Fault.Error[i].Message"));
    console.log("Detail: " + json.StringOf("Fault.Error[i].Detail"));
    console.log("code: " + json.StringOf("Fault.Error[i].code"));
    console.log("----");
    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"
// }