PureBasic

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

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 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"
    ; }

    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/qb-access-token.json")

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"sandbox-quickbooks.api.intuit.com",443,1,bAutoReconnect)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    sbAuth.i = CkStringBuilder::ckCreate()
    If sbAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbAuth,"Bearer ")
    CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"access_token"))
    CkRest::setCkAuthorization(rest, CkStringBuilder::ckGetAsString(sbAuth))

    CkRest::ckAddHeader(rest,"Accept","application/json")
    CkRest::setCkAllowHeaderFolding(rest, 0)

    ; First get the data for the employee we'll be updating..
    ; The company ID is 123146096291789
    ; The employee ID is 58
    responseBody.s = CkRest::ckFullRequestNoBody(rest,"GET","/v3/company/123146096291789/employee/58?minorversion=45")
    If CkRest::ckLastMethodSuccess(rest) = 0
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbAuth)
        ProcedureReturn
    EndIf

    ; We should expect a 200 response if successful.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Request Header: "
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "----"
        Debug "Response StatusCode = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response StatusLine: " + CkRest::ckResponseStatusText(rest)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug responseBody
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbAuth)
        ProcedureReturn
    EndIf

    ; Load the JSON response into a JSON object for parsing/updating
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,responseBody)

    ; Show the JSON..
    CkJsonObject::setCkEmitCompact(json, 0)
    Debug CkJsonObject::ckEmit(json)
    Debug "----"

    ; The JSON passed in the HTTP POST for updating is the inner content of the Employee
    updateJson.i = CkJsonObject::ckCreate()
    If updateJson.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckObjectOf2(json,"Employee",updateJson)

    ; Add or update the Line1 of the PrimaryAddr.
    CkJsonObject::ckUpdateString(updateJson,"PrimaryAddr.Line1","2W 298 Campton Hills Rd.")

    ; Examine the JSON we'll be sending in the body of the POST.
    CkJsonObject::setCkEmitCompact(updateJson, 0)
    Debug CkJsonObject::ckEmit(updateJson)
    Debug "----"

    ; Now we're going to POST the changes to update the Quickbooks account.
    CkRest::ckClearAllHeaders(rest)
    CkRest::setCkAuthorization(rest, CkStringBuilder::ckGetAsString(sbAuth))
    CkRest::ckAddHeader(rest,"Accept","application/json")
    CkRest::ckAddHeader(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.)
    responseBody = CkRest::ckFullRequestString(rest,"POST","/v3/company/123146096291789/employee?minorversion=45",CkJsonObject::ckEmit(updateJson))
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbAuth)
        CkJsonObject::ckDispose(json)
        CkJsonObject::ckDispose(updateJson)
        ProcedureReturn
    EndIf

    ; We should expect a 200 response if successful.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "Request Header: "
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "----"
        Debug "Response StatusCode = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response StatusLine: " + CkRest::ckResponseStatusText(rest)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug responseBody
        CkJsonObject::ckDispose(jsonToken)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbAuth)
        CkJsonObject::ckDispose(json)
        CkJsonObject::ckDispose(updateJson)
        ProcedureReturn
    EndIf

    ; Load the JSON response into a JSON object to emit in indented form..
    CkJsonObject::ckLoad(json,responseBody)
    Debug CkJsonObject::ckEmit(json)

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

    Debug "Success."


    CkJsonObject::ckDispose(jsonToken)
    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbAuth)
    CkJsonObject::ckDispose(json)
    CkJsonObject::ckDispose(updateJson)


    ProcedureReturn
EndProcedure