PowerBuilder

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).

PowerBuilder

integer li_rc
oleobject loo_Http
oleobject loo_Req
oleobject loo_Resp
oleobject loo_Req2
long li_BUseTls
string ls_Domain
long li_Port

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  To see the exact HTTP request sent and the response, set the SessionLogFilename property:
loo_Http.SessionLogFilename = "/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.)
loo_Req = create oleobject
li_rc = loo_Req.ConnectToNewObject("Chilkat.HttpRequest")

loo_Resp = loo_Http.PostUrlEncoded("https://www.chilkatsoft.com/blah/moreblah?key=ABC123&value=XYZ",loo_Req)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Req
    return
end if

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

destroy loo_Resp

//  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.
loo_Req2 = create oleobject
li_rc = loo_Req2.ConnectToNewObject("Chilkat.HttpRequest")

loo_Req2.Path = "/blah/moreblah?key=ABC123"
loo_Req2.AddParam("value","XYZ")
loo_Req2.HttpVerb = "POST"

li_BUseTls = 1
ls_Domain = "www.chilkatsoft.com"
li_Port = 443
loo_Resp = loo_Http.SynchronousRequest(ls_Domain,li_Port,li_BUseTls,loo_Req2)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Req
    destroy loo_Req2
    return
end if

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

destroy loo_Resp


destroy loo_Http
destroy loo_Req
destroy loo_Req2