PureBasic

SMSAPI - Edit a Subuser Account

See more SMSAPI Examples

Modify a sub-user account. 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 -X PUT -H "Content-Type: application/json" \
    ; -H "Authorization: Bearer token_api_oauth" -d\
    ; '{"credentials":{"password":"Customer_portal_password","api_password":"API_password"}, 
    ; "active":"1","description":"Test description","points":{"from_account":"2","per_month":"2"}}'
    ; 'https://api.smsapi.com/subusers/{subuser_id}'

    ; Use the following online tool to generate HTTP code from a CURL command
    ; Convert a cURL Command to HTTP Source Code

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "credentials": {
    ;     "password": "Customer_portal_password",
    ;     "api_password": "API_password"
    ;   },
    ;   "active": "1",
    ;   "description": "Test description",
    ;   "points": {
    ;     "from_account": "2",
    ;     "per_month": "2"
    ;   }
    ; }

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

    CkJsonObject::ckUpdateString(json,"credentials.password","new_Password_1234")
    CkJsonObject::ckUpdateString(json,"credentials.api_password","new_API_password_1234")
    CkJsonObject::ckUpdateString(json,"active","1")
    CkJsonObject::ckUpdateString(json,"description","Test description")
    CkJsonObject::ckUpdateString(json,"points.from_account","3")
    CkJsonObject::ckUpdateString(json,"points.per_month","3")

    ; Adds the "Authorization: Bearer token_api_oauth" header.
    CkHttp::setCkAuthToken(http, "token_api_oauth")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

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

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    ; In this example, the subuser_id is 5F8BB03E6436384B0AB36F1B
    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpSb(http,"PUT","https://api.smsapi.com/subusers/5F8BB03E6436384B0AB36F1B",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

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

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

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

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "id": "5F8BB03E6436384B0AB36F1B",
    ;   "username": "TestUser",
    ;   "active": true,
    ;   "description": "Test description",
    ;   "points": {
    ;     "from_account": 3.0,
    ;     "per_month": 3.0
    ;   }
    ; }

    ; Sample code for parsing the JSON response...
    ; Use the following online tool to generate parsing code from sample JSON:
    ; Generate Parsing Code from JSON

    id.s = CkJsonObject::ckStringOf(jResp,"id")
    username.s = CkJsonObject::ckStringOf(jResp,"username")
    active.i = CkJsonObject::ckBoolOf(jResp,"active")
    description.s = CkJsonObject::ckStringOf(jResp,"description")
    pointsFrom_account.s = CkJsonObject::ckStringOf(jResp,"points.from_account")
    pointsPer_month.s = CkJsonObject::ckStringOf(jResp,"points.per_month")


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


    ProcedureReturn
EndProcedure