PureBasic

MYOB: Update a Category

See more MYOB Examples

Sends a PUT to update a category. PureBasic

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.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.

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

    ; Implements the following CURL command:

    ; curl --request PUT "https://ar1.api.myob.com/accountright/c06778dd-4371-4a83-975f-522df65d7574/GeneralLedger/Category/{{category_id}}" \
    ;   --header "Authorization: Bearer ACCESS_TOKEN" \
    ;   --header "x-myobapi-key: This is your API Key" \
    ;   --header "x-myobapi-version: v2" \
    ;   --header "Accept-Encoding: gzip,deflate" \
    ;   --data "{
    ;             \"UID\": \"20b483b2-9a89-4793-b8c3-2da1a6284e1f\",
    ;             \"DisplayID\": \"Postman001\",
    ;             \"Name\": \"Postman sample\",
    ;             \"Description\": \"This has been updated via Postman\",
    ;             \"IsActive\": true,
    ;             \"RowVersion\": \"-8858580467037765632\"
    ;         }"

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "UID": "20b483b2-9a89-4793-b8c3-2da1a6284e1f",
    ;   "DisplayID": "Postman001",
    ;   "Name": "Postman sample",
    ;   "Description": "This has been updated via Postman",
    ;   "IsActive": true,
    ;   "RowVersion": "-8858580467037765632"
    ; }

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

    CkJsonObject::ckUpdateString(json,"UID","20b483b2-9a89-4793-b8c3-2da1a6284e1f")
    CkJsonObject::ckUpdateString(json,"DisplayID","Postman001")
    CkJsonObject::ckUpdateString(json,"Name","Postman sample")
    CkJsonObject::ckUpdateString(json,"Description","This has been updated via Postman")
    CkJsonObject::ckUpdateBool(json,"IsActive",1)
    CkJsonObject::ckUpdateString(json,"RowVersion","-8858580467037765632")

    CkHttp::ckSetRequestHeader(http,"Authorization","Bearer ACCESS_TOKEN")
    CkHttp::ckSetRequestHeader(http,"x-myobapi-key","This is your API Key")
    CkHttp::ckSetRequestHeader(http,"Accept-Encoding","gzip,deflate")
    CkHttp::ckSetRequestHeader(http,"x-myobapi-version","v2")

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

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

    success = CkHttp::ckHttpSb(http,"PUT","https://ar1.api.myob.com/accountright/c06778dd-4371-4a83-975f-522df65d7574/GeneralLedger/Category/{{category_id}}",sbRequestBody,"utf-8","application/json",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode <> 200
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Response Body:"
        Debug CkHttpResponse::ckBodyStr(resp)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    Debug "Success."


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkHttpResponse::ckDispose(resp)


    ProcedureReturn
EndProcedure