Xbase++

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. Xbase++

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oSbAuth
LOCAL cResponseBody
LOCAL oJson
LOCAL nNumErrors
LOCAL i

nSuccess := 0

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

oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/qb-access-token.json")

oRest := 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.
nBAutoReconnect := 1
nSuccess := oRest:Connect("sandbox-quickbooks.api.intuit.com", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oRest:destroy()
    RETURN
ENDIF

oSbAuth := CreateObject("Chilkat.StringBuilder")
oSbAuth:Append("Bearer ")
oSbAuth:Append(oJsonToken:StringOf("access_token"))
oRest:Authorization := oSbAuth:GetAsString()

oRest:AddHeader("Accept", "application/json")
oRest: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.)
cResponseBody := oRest:FullRequestNoBody("GET", "/v3/company/123146096291789/employee/999?minorversion=45")
IF (oRest:LastMethodSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oRest:destroy()
    oSbAuth:destroy()
    RETURN
ENDIF

//  Load the JSON response into a JSON object for parsing.
//  A sample JSON response is shown below.
oJson := CreateObject("Chilkat.JsonObject")
oJson:Load(cResponseBody)
oJson:EmitCompact := 0
? oJson:Emit()

//  A 400 response is what we'd expect if trying to query for a non-existent employee ID
IF (oRest:ResponseStatusCode != 400)
    ? "Request Header: "
    ? oRest:LastRequestHeader
    ? "----"
    ? "Response StatusCode = " + Str(oRest:ResponseStatusCode)
    ? "Response StatusLine: " + oRest:ResponseStatusText
    ? "Response Header:"
    ? oRest:ResponseHeader
    oJsonToken:destroy()
    oRest:destroy()
    oSbAuth:destroy()
    oJson:destroy()
    RETURN
ENDIF

//  If we got here, the response status code was 400..
//  Iterate over the errors..
nNumErrors := oJson:SizeOfArray("Fault.Error")
i := 0
DO WHILE i < nNumErrors

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

oJsonToken:destroy()
oRest:destroy()
oSbAuth:destroy()
oJson:destroy()