(Tcl) URL Encoding Charset in POST Query Params

Demonstrates how to control the URL encoding charset in POST query params.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# We have the string "MÆRSK".
set nameWin1252Encoded "M%E6RSK"

# Note: The DecodeAndAppend method is newly added in Chilkat v9.5.0.87
set sb [new_CkStringBuilder]

set success [CkStringBuilder_DecodeAndAppend $sb $nameWin1252Encoded "url" "windows-1252"]

set http [new_CkHttp]

# We're setting the session log filename so we can see the exact request sent.
CkHttp_put_SessionLogFilename $http "qa_output/sessionLog.txt"

# First demonstrate a simple application/x-www-form-urlencoded POST

set req [new_CkHttpRequest]

# Set the Charset = "utf-8" to cause URL encoding to use utf-8.
CkHttpRequest_put_Charset $req "utf-8"

CkHttpRequest_AddParam $req "name" [CkStringBuilder_getAsString $sb]

# resp is a CkHttpResponse
set resp [CkHttp_PostUrlEncoded $http "https://www.chilkatsoft.com/something" $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkStringBuilder $sb
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

# This is the request that is sent:
# Notice that utf-8 is used in the query param (the letter 'Æ' is %C3%A6)

# 	POST /something HTTP/1.1
# 	Host: www.chilkatsoft.com
# 	Content-Type: application/x-www-form-urlencoded
# 	Content-Length: 15
# 
# 	name=M%C3%A6RSK

delete_CkHttpResponse $resp

# ---------------------------------------------------------------
# Switch to windows-1252

CkHttpRequest_put_Charset $req "windows-1252"

set resp [CkHttp_PostUrlEncoded $http "https://www.chilkatsoft.com/something" $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkStringBuilder $sb
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

# This is the request that is sent:
# Notice that windows-1252 is used in the query param (the letter 'Æ' is %E6)

# 	POST /something HTTP/1.1
# 	Host: www.chilkatsoft.com
# 	Content-Type: application/x-www-form-urlencoded
# 	Content-Length: 12
# 
# 	name=M%E6RSK

delete_CkHttpResponse $resp

# ---------------------------------------------------------------
# Let's do the same with SynchronousRequest, switching back to utf-8

CkHttpRequest_put_Path $req "/something"
CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_ContentType $req "application/x-www-form-urlencoded"

CkHttpRequest_put_Charset $req "utf-8"

set resp [CkHttp_SynchronousRequest $http "www.chilkatsoft.com" 443 1 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkStringBuilder $sb
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

# This is the request that is sent:
# Notice that utf-8 is used in the query param (the letter 'Æ' is %C3%A6)

# 	POST /something HTTP/1.1
# 	Host: www.chilkatsoft.com
# 	Content-Type: application/x-www-form-urlencoded
# 	Content-Length: 15
# 
# 	name=M%C3%A6RSK

delete_CkHttpResponse $resp

# ---------------------------------------------------------------
# Let's do a PostXml where the query params are in the HTTP request start line, 
# and the Content-Type is text/xml where the body of the request is XML.

CkHttpRequest_put_Path $req "/something"
CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_ContentType $req "text/xml"
set success [CkHttpRequest_LoadBodyFromString $req "<test>123</test>" "utf-8"]
CkHttpRequest_put_Charset $req "utf-8"

# Remember... our request object still contains the query param added in the above call to AddParam.

set resp [CkHttp_SynchronousRequest $http "www.chilkatsoft.com" 443 1 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkStringBuilder $sb
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

# This is the request that is sent:
# Notice that utf-8 is used in the query param (the letter 'Æ' is %C3%A6)

# 	POST /something?name=M%C3%A6RSK HTTP/1.1
# 	Host: www.chilkatsoft.com
# 	Content-Type: text/xml
# 	Content-Length: 16
# 
# 	<test>123</test>

delete_CkHttpResponse $resp


delete_CkStringBuilder $sb
delete_CkHttp $http
delete_CkHttpRequest $req