SQL Server

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

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- To see the exact HTTP request sent and the response, set the SessionLogFilename property:
    EXEC sp_OASetProperty @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.)
    DECLARE @req int
    EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @req OUT

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostUrlEncoded', @resp OUT, 'https://www.chilkatsoft.com/blah/moreblah?key=ABC123&value=XYZ', @req
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        RETURN
      END

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

    EXEC @hr = sp_OADestroy @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.
    DECLARE @req2 int
    EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @req2 OUT

    EXEC sp_OASetProperty @req2, 'Path', '/blah/moreblah?key=ABC123'
    EXEC sp_OAMethod @req2, 'AddParam', NULL, 'value', 'XYZ'
    EXEC sp_OASetProperty @req2, 'HttpVerb', 'POST'

    DECLARE @bUseTls int
    SELECT @bUseTls = 1
    DECLARE @domain nvarchar(4000)
    SELECT @domain = 'www.chilkatsoft.com'
    DECLARE @port int
    SELECT @port = 443
    EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, @domain, @port, @bUseTls, @req2
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @req2
        RETURN
      END

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

    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @req
    EXEC @hr = sp_OADestroy @req2


END
GO