DataFlex

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. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
Token    Handle hoJsonToken
    Handle hoRest
    Boolean iBAutoReconnect
    Handle hoSbAuth
    String sResponseBody
    Handle hoJson
    Integer iNumErrors
    Integer i
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/qb-access-token.json" To iSuccess

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    // 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.
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "sandbox-quickbooks.api.intuit.com" 443 True iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAuth
    If (Not(IsComObjectCreated(hoSbAuth))) Begin
        Send CreateComObject of hoSbAuth
    End
    Get ComAppend Of hoSbAuth "Bearer " To iSuccess
    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Get ComAppend Of hoSbAuth sTemp1 To iSuccess
    Get ComGetAsString Of hoSbAuth To sTemp1
    Set ComAuthorization Of hoRest To sTemp1

    Get ComAddHeader Of hoRest "Accept" "application/json" To iSuccess
    Set ComAllowHeaderFolding Of hoRest To 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.)
    Get ComFullRequestNoBody Of hoRest "GET" "/v3/company/123146096291789/employee/999?minorversion=45" To sResponseBody
    Get ComLastMethodSuccess Of hoRest To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Load the JSON response into a JSON object for parsing.
    // A sample JSON response is shown below.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComLoad Of hoJson sResponseBody To iSuccess
    Set ComEmitCompact Of hoJson To False
    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1

    // A 400 response is what we'd expect if trying to query for a non-existent employee ID
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 400) Begin
        Showln "Request Header: "
        Get ComLastRequestHeader Of hoRest To sTemp1
        Showln sTemp1
        Showln "----"
        Get ComResponseStatusCode Of hoRest To iTemp1
        Showln "Response StatusCode = " iTemp1
        Get ComResponseStatusText Of hoRest To sTemp1
        Showln "Response StatusLine: " sTemp1
        Showln "Response Header:"
        Get ComResponseHeader Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // If we got here, the response status code was 400..
    // Iterate over the errors..
    Get ComSizeOfArray Of hoJson "Fault.Error" To iNumErrors
    Move 0 To i
    While (i < iNumErrors)

        Set ComI Of hoJson To i
        Get ComStringOf Of hoJson "Fault.Error[i].Message" To sTemp1
        Showln "Message: " sTemp1
        Get ComStringOf Of hoJson "Fault.Error[i].Detail" To sTemp1
        Showln "Detail: " sTemp1
        Get ComStringOf Of hoJson "Fault.Error[i].code" To sTemp1
        Showln "code: " sTemp1
        Showln "----"
        Move (i + 1) To i
    Loop

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


End_Procedure