Java

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. Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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"
        // }

        JsonObject jsonToken = new JsonObject();
        jsonToken.loadFile("qa_data/tokens/qb-access-token.json");

        Rest rest = new 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.
        boolean bAutoReconnect = true;
        try {
            rest.connect("sandbox-quickbooks.api.intuit.com", 443, true, bAutoReconnect);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        StringBuilder sbAuth = new StringBuilder();
        sbAuth.append("Bearer ");
        sbAuth.append(jsonToken.stringOf("access_token"));
        rest.setAuthorization(sbAuth.getAsString());

        rest.addHeader("Accept", "application/json");
        rest.setAllowHeaderFolding(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.)
        String responseBody;
        try {
            responseBody = rest.fullRequestNoBody("GET", "/v3/company/123146096291789/employee/999?minorversion=45");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Load the JSON response into a JSON object for parsing.
        // A sample JSON response is shown below.
        JsonObject json = new JsonObject();
        json.load(responseBody);
        json.setEmitCompact(false);
        System.out.println(json.emit());

        // A 400 response is what we'd expect if trying to query for a non-existent employee ID
        if (rest.getResponseStatusCode() != 400) {
            System.out.println("Request Header: ");
            System.out.println(rest.getLastRequestHeader());
            System.out.println("----");
            System.out.println("Response StatusCode = " + rest.getResponseStatusCode());
            System.out.println("Response StatusLine: " + rest.getResponseStatusText());
            System.out.println("Response Header:");
            System.out.println(rest.getResponseHeader());
            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.setI(i);
            System.out.println("Message: " + json.stringOf("Fault.Error[i].Message"));
            System.out.println("Detail: " + json.stringOf("Fault.Error[i].Detail"));
            System.out.println("code: " + json.stringOf("Fault.Error[i].code"));
            System.out.println("----");
            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"
        // }
    }
}