SQL Server

HTTPS GET URL with URL Encoded Query Params

See more HTTP Examples

Creates a URL with URL encoded query params, and sends an HTTPS GET to the URL. 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)
    DECLARE @success int
    SELECT @success = 0

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

    -- Create a URL with URL-encoded query params.
    DECLARE @sbUrl int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbUrl OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OAMethod @sbUrl, 'Append', @success OUT, 'https://www.example.com/something?'

    -- If we know a query param value does not have any special chars requiring URL encoding,
    -- just add it.  In this case, there is no need to URL encode "123" because "123" url encoded is still just "123".
    EXEC sp_OAMethod @sbUrl, 'Append', @success OUT, 'abc=123&xyz='

    DECLARE @sbValue int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbValue OUT

    EXEC sp_OAMethod @sbValue, 'Append', @success OUT, 'this is a test'

    EXEC sp_OAMethod @sbUrl, 'Append', @success OUT, 'msg='
    EXEC sp_OAMethod @sbValue, 'GetEncoded', @sTmp0 OUT, 'url', 'utf-8'
    EXEC sp_OAMethod @sbUrl, 'Append', @success OUT, @sTmp0

    -- sbUrl contains:  https://www.example.com/something?abc=123&xyz=msg=this%20is%20a%20test
    EXEC sp_OAMethod @sbUrl, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    -- Send the GET request and get the response body, which is assumed to be text of some sort (HTML, XML, JSON, etc.)
    -- (Chilkat automatically decompresses gzipped responses)
    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT

    DECLARE @responseBody nvarchar(4000)
    EXEC sp_OAMethod @sbUrl, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @http, 'QuickGetStr', @responseBody OUT, @sTmp0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbUrl
        EXEC @hr = sp_OADestroy @sbValue
        EXEC @hr = sp_OADestroy @http
        RETURN
      END


    PRINT 'Response Body:'

    PRINT @responseBody

    EXEC @hr = sp_OADestroy @sbUrl
    EXEC @hr = sp_OADestroy @sbValue
    EXEC @hr = sp_OADestroy @http


END
GO