DataFlex

PostUrlEncoded Clarified

This example is intended to help clarify the behavior of the PostUrlEncoded method.

The intent of PostUrlEncoded is to send a POST request with the HTTP request parameters located in the HTTP request body using the x-www-form-urlencoded format. In many cases, the developer already has the desired request params in a typical GET URL format, where the params are specified in the URL (after the "?" character). For example:

https://www.chilkatsoft.com/blah/moreblah?key=ABC123&value=XYZ

The PostUrlEncoded method makes it possible to send this request as a POST, where the "key=ABC123&value=XYZ" is contained in the body of the request. The path part of the URL is "/blah/moreblah". Therefore, the POST request would look like this:

POST /blah/moreblah HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: www.chilkatsoft.com
Content-Length: 20

key=ABC123&value=XYZ

Sometimes the desire is to send a POST, such that some (or all) request parameters are found in the path, and not in the request body. For example, let's say a program wants to send this request:

POST /blah/moreblah?key=ABC123 HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: www.chilkatsoft.com
Content-Length: 10

value=XYZ

This can be done by calling SynchronousRequest. The SynchronousRequest method allows for the parts of the request to be explicitly built via the HTTP request object. (see the example code below).

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Variant vReq
    Handle hoReq
    Variant vResp
    Handle hoResp
    Variant vReq
2    Handle hoReq2
    Boolean iBUseTls
    String sDomain
    Integer iPort
    String sTemp1
    Boolean bTemp1

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

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

    // To see the exact HTTP request sent and the response, set the SessionLogFilename property:
    Set ComSessionLogFilename Of hoHttp To "/httpLogs/chilkatHttpLog.txt"

    // Send the POST where all request parameters are located in the HTTP request body
    // in the x-www-form-urlencoded format.  (We are passing a default/empty HTTP request object.
    // The HTTP request object is where additional headers, or additional request parameters
    // be added.)
    Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
    If (Not(IsComObjectCreated(hoReq))) Begin
        Send CreateComObject of hoReq
    End
    Get pvComObject of hoReq to vReq
    Get ComPostUrlEncoded Of hoHttp "https://www.chilkatsoft.com/blah/moreblah?key=ABC123&value=XYZ" vReq To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Do whatever is desired with the response object...

    Send Destroy of hoResp

    // Show how to call SynchronousRequest to send a POST where "key=ABC123" is in the path 
    // of the request, and the "value=XYZ" is in the request body.
    Get Create (RefClass(cComChilkatHttpRequest)) To hoReq2
    If (Not(IsComObjectCreated(hoReq2))) Begin
        Send CreateComObject of hoReq2
    End
    Set ComPath Of hoReq2 To "/blah/moreblah?key=ABC123"
    Send ComAddParam To hoReq2 "value" "XYZ"
    Set ComHttpVerb Of hoReq2 To "POST"

    Move True To iBUseTls
    Move "www.chilkatsoft.com" To sDomain
    Move 443 To iPort
    Get pvComObject of hoReq2 to vReq2
    Get ComSynchronousRequest Of hoHttp sDomain iPort iBUseTls vReq2 To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Do whatever is desired with the response object...

    Send Destroy of hoResp


End_Procedure