Tcl

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

load ./chilkat.dll

set success 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"
# }

set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/qb-access-token.json"]

set 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.
set bAutoReconnect 1
set success [CkRest_Connect $rest "sandbox-quickbooks.api.intuit.com" 443 1 $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    exit
}

set sbAuth [new_CkStringBuilder]

CkStringBuilder_Append $sbAuth "Bearer "
CkStringBuilder_Append $sbAuth [CkJsonObject_stringOf $jsonToken "access_token"]
CkRest_put_Authorization $rest [CkStringBuilder_getAsString $sbAuth]

CkRest_AddHeader $rest "Accept" "application/json"
CkRest_put_AllowHeaderFolding $rest 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.)
set responseBody [CkRest_fullRequestNoBody $rest "GET" "/v3/company/123146096291789/employee/999?minorversion=45"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    delete_CkStringBuilder $sbAuth
    exit
}

# Load the JSON response into a JSON object for parsing.
# A sample JSON response is shown below.
set json [new_CkJsonObject]

CkJsonObject_Load $json $responseBody
CkJsonObject_put_EmitCompact $json 0
puts [CkJsonObject_emit $json]

# A 400 response is what we'd expect if trying to query for a non-existent employee ID
if {[CkRest_get_ResponseStatusCode $rest] != 400} then {
    puts "Request Header: "
    puts [CkRest_lastRequestHeader $rest]
    puts "----"
    puts "Response StatusCode = [CkRest_get_ResponseStatusCode $rest]"
    puts "Response StatusLine: [CkRest_responseStatusText $rest]"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    delete_CkStringBuilder $sbAuth
    delete_CkJsonObject $json
    exit
}

# If we got here, the response status code was 400..
# Iterate over the errors..
set numErrors [CkJsonObject_SizeOfArray $json "Fault.Error"]
set i 0
while {$i < $numErrors} {

    CkJsonObject_put_I $json $i
    puts "Message: [CkJsonObject_stringOf $json {Fault.Error[i].Message}]"
    puts "Detail: [CkJsonObject_stringOf $json {Fault.Error[i].Detail}]"
    puts "code: [CkJsonObject_stringOf $json {Fault.Error[i].code}]"
    puts "----"
    set i [expr $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"
# }

delete_CkJsonObject $jsonToken
delete_CkRest $rest
delete_CkStringBuilder $sbAuth
delete_CkJsonObject $json