Tcl

SMSAPI - Edit a Subuser Account

See more SMSAPI Examples

Modify a sub-user account. 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.

set http [new_CkHttp]

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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "credentials.password" "new_Password_1234"
CkJsonObject_UpdateString $json "credentials.api_password" "new_API_password_1234"
CkJsonObject_UpdateString $json "active" "1"
CkJsonObject_UpdateString $json "description" "Test description"
CkJsonObject_UpdateString $json "points.from_account" "3"
CkJsonObject_UpdateString $json "points.per_month" "3"

# Adds the "Authorization: Bearer token_api_oauth" header.
CkHttp_put_AuthToken $http "token_api_oauth"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# In this example, the subuser_id is 5F8BB03E6436384B0AB36F1B
set resp [new_CkHttpResponse]

set success [CkHttp_HttpSb $http "PUT" "https://api.smsapi.com/subusers/5F8BB03E6436384B0AB36F1B" $sbRequestBody "utf-8" "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set id [CkJsonObject_stringOf $jResp "id"]
set username [CkJsonObject_stringOf $jResp "username"]
set active [CkJsonObject_BoolOf $jResp "active"]
set description [CkJsonObject_stringOf $jResp "description"]
set pointsFrom_account [CkJsonObject_stringOf $jResp "points.from_account"]
set pointsPer_month [CkJsonObject_stringOf $jResp "points.per_month"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp