(DataFlex) URL Encoding Charset in POST Query Params

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

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    String sNameWin1252Encoded
    Handle hoSb
    Handle hoHttp
    Variant vReq
    Handle hoReq
    Variant vResp
    Handle hoResp
    String sTemp1

    Move False To iSuccess

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

    // We have the string "MÆRSK".
    Move "M%E6RSK" To sNameWin1252Encoded

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSb
    If (Not(IsComObjectCreated(hoSb))) Begin
        Send CreateComObject of hoSb
    End
    Get ComDecodeAndAppend Of hoSb sNameWin1252Encoded "url" "windows-1252" To iSuccess

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // We're setting the session log filename so we can see the exact request sent.
    Set ComSessionLogFilename Of hoHttp To "qa_output/sessionLog.txt"

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

    Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
    If (Not(IsComObjectCreated(hoReq))) Begin
        Send CreateComObject of hoReq
    End

    // Set the Charset = "utf-8" to cause URL encoding to use utf-8.
    Set ComCharset Of hoReq To "utf-8"

    Get ComGetAsString Of hoSb To sTemp1
    Send ComAddParam To hoReq "name" sTemp1

    Set ComHttpVerb Of hoReq To "POST"
    Set ComContentType Of hoReq To "application/x-www-form-urlencoded"

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoReq to vReq
    Get pvComObject of hoResp to vResp
    Get ComHttpReq Of hoHttp "https://www.chilkatsoft.com/something" vReq vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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

    // ---------------------------------------------------------------
    // Switch to windows-1252

    Set ComCharset Of hoReq To "windows-1252"
    Set ComHttpVerb Of hoReq To "POST"
    Set ComContentType Of hoReq To "application/x-www-form-urlencoded"

    Get pvComObject of hoReq to vReq
    Get pvComObject of hoResp to vResp
    Get ComHttpReq Of hoHttp "https://www.chilkatsoft.com/something" vReq vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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

    // ---------------------------------------------------------------
    // Let's do the same with HttpSReq, switching back to utf-8

    Set ComPath Of hoReq To "/something"
    Set ComHttpVerb Of hoReq To "POST"
    Set ComContentType Of hoReq To "application/x-www-form-urlencoded"

    Set ComCharset Of hoReq To "utf-8"
    Get pvComObject of hoReq to vReq
    Get pvComObject of hoResp to vResp
    Get ComHttpSReq Of hoHttp "www.chilkatsoft.com" 443 True vReq vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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

    // ---------------------------------------------------------------
    // Let's do a POST with XML body 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.

    Set ComPath Of hoReq To "/something"
    Set ComHttpVerb Of hoReq To "POST"
    Set ComContentType Of hoReq To "text/xml"
    Get ComLoadBodyFromString Of hoReq "<test>123</test>" "utf-8" To iSuccess
    Set ComCharset Of hoReq To "utf-8"

    // Remember... our request object still contains the query param added in the above call to AddParam.
    Get pvComObject of hoReq to vReq
    Get pvComObject of hoResp to vResp
    Get ComHttpSReq Of hoHttp "www.chilkatsoft.com" 443 True vReq vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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>


End_Procedure