Tcl

QuickBooks - Full Update an Employee

See more QuickBooks Examples

Demonstrates how to update any of the writable fields of an existing employee. The example first reads the JSON data for the employee, makes some changes, and then POST's the updated JSON to update the employee. 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 == 0} 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

# First get the data for the employee we'll be updating..
# The company ID is 123146096291789
# The employee ID is 58
set responseBody [CkRest_fullRequestNoBody $rest "GET" "/v3/company/123146096291789/employee/58?minorversion=45"]
if {[CkRest_get_LastMethodSuccess $rest] == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    delete_CkStringBuilder $sbAuth
    exit
}

# We should expect a 200 response if successful.
if {[CkRest_get_ResponseStatusCode $rest] != 200} 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]
    puts "$responseBody"
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    delete_CkStringBuilder $sbAuth
    exit
}

# Load the JSON response into a JSON object for parsing/updating
set json [new_CkJsonObject]

CkJsonObject_Load $json $responseBody

# Show the JSON..
CkJsonObject_put_EmitCompact $json 0
puts [CkJsonObject_emit $json]
puts "----"

# The JSON passed in the HTTP POST for updating is the inner content of the Employee
set updateJson [new_CkJsonObject]

CkJsonObject_ObjectOf2 $json "Employee" $updateJson

# Add or update the Line1 of the PrimaryAddr.
CkJsonObject_UpdateString $updateJson "PrimaryAddr.Line1" "2W 298 Campton Hills Rd."

# Examine the JSON we'll be sending in the body of the POST.
CkJsonObject_put_EmitCompact $updateJson 0
puts [CkJsonObject_emit $updateJson]
puts "----"

# Now we're going to POST the changes to update the Quickbooks account.
CkRest_ClearAllHeaders $rest
CkRest_put_Authorization $rest [CkStringBuilder_getAsString $sbAuth]
CkRest_AddHeader $rest "Accept" "application/json"
CkRest_AddHeader $rest "Content-Type" "application/json"

# The updated JSON is passed as the HTTP request body.
# (The employee ID is specified in the JSON body of the request, and therefore is is not in the path.)
set responseBody [CkRest_fullRequestString $rest "POST" "/v3/company/123146096291789/employee?minorversion=45" [CkJsonObject_emit $updateJson]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    delete_CkStringBuilder $sbAuth
    delete_CkJsonObject $json
    delete_CkJsonObject $updateJson
    exit
}

# We should expect a 200 response if successful.
if {[CkRest_get_ResponseStatusCode $rest] != 200} 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]
    puts "$responseBody"
    delete_CkJsonObject $jsonToken
    delete_CkRest $rest
    delete_CkStringBuilder $sbAuth
    delete_CkJsonObject $json
    delete_CkJsonObject $updateJson
    exit
}

# Load the JSON response into a JSON object to emit in indented form..
CkJsonObject_Load $json $responseBody
puts [CkJsonObject_emit $json]

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

puts "Success."

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