(PureBasic) PostXml vs. PostUrlEncoded

This example shows the differences in the HTTP requests sent by PostXml vs. PostUrlEncoded. With PostXml, the body of the request is the XML document itself. With PostUrlEncoded, the body of the request is composed of URL encoded params, as shown in the example below.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

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

    success.i

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

    strXml.s = "<pets><lizard>Pip</lizard><dog>Fido</dog></pets>"

    ;  We can log the exact HTTP requests/responses to a session log file.
    CkHttp::setCkSessionLogFilename(http, "qa_output/sessionLog.txt")

    ;  Send a POST w/ content-type of "application/xml"
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/xml")

    ;  Note: This example is only interested in examining (via the session log)
    ;  the HTTP requests that are sent.  We're just sending the post to chilkatsoft.com
    ;  even though it's not an endpoint designed to handle the POST. We don't care about
    ;  the response, even if it's an error response status code..
    resp.i = CkHttp::ckPostXml(http,"https://www.chilkatsoft.com/",strXml,"utf-8")
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ;  This is the HTTP request that is sent.
    ;  You'll notice the body of the request is the XML document itself.

    ;  	POST / HTTP/1.1
    ;  	Content-Type: application/xml
    ;  	Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
    ;  	Connection: keep-alive
    ;  	User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:49.0) Gecko/20100101 Firefox/49.0
    ;  	Accept-Language: en-us,en;q=0.5
    ;  	Accept-Encoding: gzip
    ;  	Host: www.chilkatsoft.com
    ;  	Content-Length: 48
    ; 
    ;  	<pets><lizard>Pip</lizard><dog>Fido</dog></pets>

    ;  --------
    ;  Now let's do a PostUrlEncoded...
    ;  The XML is passed in a query param that is contained in the body of the POST.
    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::ckAddParam(req,"theXml",strXml)
    resp = CkHttp::ckPostUrlEncoded(http,"https://www.chilkatsoft.com/",req)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ;  This is the HTTP request that is sent.
    ;  You'll notice the body of the request is composed of URL encoded query params.

    ;  	POST / HTTP/1.1
    ;  	Content-Type: application/x-www-form-urlencoded
    ;  	Host: www.chilkatsoft.com
    ;  	Content-Length: 85
    ; 
    ;  	theXml=%3Cpets%3E%3Clizard%3EPip%3C%2Flizard%3E%3Cdog%3EFido%3C%2Fdog%3E%3C%2Fpets%3E
    ; 

    ;  --------
    ;  Let's try one more thing...
    ;  If the query params are not too large, they can be passed in the URL (which means the query params are passed
    ;  in the HTTP start line.  This is what happens when a URL w/ query params are pasted in a browser.
    ;  The HTTP verb is "GET" instead of "POST".

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

    CkStringBuilder::ckAppend(sbUrl,"https://www.chilkatsoft.com/?")
    CkStringBuilder::ckAppend(sbUrl,CkHttpRequest::ckGetUrlEncodedParams(req))
    Debug "URL with query params: " + CkStringBuilder::ckGetAsString(sbUrl)
    strResponse.s = CkHttp::ckQuickGetStr(http,CkStringBuilder::ckGetAsString(sbUrl))

    ;  The URL with query params is:  https://www.chilkatsoft.com/?theXml=%3Cpets%3E%3Clizard%3EPip%3C%2Flizard%3E%3Cdog%3EFido%3C%2Fdog%3E%3C%2Fpets%3E

    ;  The HTTP request looks like this.  You can see there is no request body, and the query params
    ;  are in the path part of the start line.

    ;  	GET /?theXml=%3Cpets%3E%3Clizard%3EPip%3C%2Flizard%3E%3Cdog%3EFido%3C%2Fdog%3E%3C%2Fpets%3E HTTP/1.1
    ;  	Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
    ;  	Connection: keep-alive
    ;  	User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:49.0) Gecko/20100101 Firefox/49.0
    ;  	Accept-Language: en-us,en;q=0.5
    ;  	Accept-Encoding: gzip
    ;  	Host: www.chilkatsoft.com


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkStringBuilder::ckDispose(sbUrl)


    ProcedureReturn
EndProcedure