(Visual FoxPro) 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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loJsonToken
LOCAL lnSuccess
LOCAL loRest
LOCAL lnBAutoReconnect
LOCAL loSbAuth
LOCAL lcResponseBody
LOCAL loJson
LOCAL lnNumErrors
LOCAL i

* 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"
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJsonToken = CreateObject('Chilkat.JsonObject')
lnSuccess = loJsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Rest')
loRest = CreateObject('Chilkat.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.
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("sandbox-quickbooks.api.intuit.com",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loRest
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbAuth = CreateObject('Chilkat.StringBuilder')
loSbAuth.Append("Bearer ")
loSbAuth.Append(loJsonToken.StringOf("access_token"))
loRest.Authorization = loSbAuth.GetAsString()

loRest.AddHeader("Accept","application/json")
loRest.AllowHeaderFolding = 0

* 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.)
lcResponseBody = loRest.FullRequestNoBody("GET","/v3/company/123146096291789/employee/999?minorversion=45")
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loJsonToken
    RELEASE loRest
    RELEASE loSbAuth
    CANCEL
ENDIF

* Load the JSON response into a JSON object for parsing.
* A sample JSON response is shown below.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.Load(lcResponseBody)
loJson.EmitCompact = 0
? loJson.Emit()

* A 400 response is what we'd expect if trying to query for a non-existent employee ID
IF (loRest.ResponseStatusCode <> 400) THEN
    ? "Request Header: "
    ? loRest.LastRequestHeader
    ? "----"
    ? "Response StatusCode = " + STR(loRest.ResponseStatusCode)
    ? "Response StatusLine: " + loRest.ResponseStatusText
    ? "Response Header:"
    ? loRest.ResponseHeader
    RELEASE loJsonToken
    RELEASE loRest
    RELEASE loSbAuth
    RELEASE loJson
    CANCEL
ENDIF

* If we got here, the response status code was 400..
* Iterate over the errors..
lnNumErrors = loJson.SizeOfArray("Fault.Error")
i = 0
DO WHILE i < lnNumErrors

    loJson.I = i
    ? "Message: " + loJson.StringOf("Fault.Error[i].Message")
    ? "Detail: " + loJson.StringOf("Fault.Error[i].Detail")
    ? "code: " + loJson.StringOf("Fault.Error[i].code")
    ? "----"
    i = i + 1
ENDDO

* ------------------------------------------------------
* 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"
* }

RELEASE loJsonToken
RELEASE loRest
RELEASE loSbAuth
RELEASE loJson