SQL Server

HTTP Methods - GET and DELETE

Demonstrate a method for sending HTTP requests that don't have a request body, such as for GET or DELETE requests. 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
    -- 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.

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

    -- Specifiy a session log file so we can see the exact request/response
    EXEC sp_OASetProperty @http, 'SessionLogFilename', 'c:/aaworkarea/sessionLog.txt'

    -- Perhaps add a custom header or two..
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-exz-date', '20201012T235046Z'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-exz-id', '1234'

    -- Send a GET request to https://www.example.com/someting?param1=123&param2=abc
    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://www.example.com/someting?param1=123&param2=abc'
    DECLARE @resp int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    EXEC sp_OAMethod @http, 'HttpNoBody', @success OUT, 'GET', @url, @resp
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END

    -- The GET request that is sent looks like this.
    -- The Accept and Accept-Encoding headers are automatically added by default.

    -- 	GET /someting?param1=123&param2=abc HTTP/1.1
    -- 	Host: www.example.com
    -- 	Accept: */*
    -- 	Accept-Encoding: gzip
    -- 	x-exz-date: 20201012T235046Z
    -- 	x-exz-id: 1234

    -- Get the response status
    DECLARE @statusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @statusCode OUT

    PRINT 'Response status: ' + @statusCode

    -- Get the response body
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0

    -- -------------------------------------------------------------
    -- Let's say we want to send a DELETE request, and we only want to accept an application/json response,
    -- and we don't want gzipped responses...

    -- First remove the previously specified custom headers.
    EXEC sp_OAMethod @http, 'ClearHeaders', NULL

    -- Indicate we only accept application/json non-gzipped responses.
    EXEC sp_OASetProperty @http, 'Accept', 'application/json'
    EXEC sp_OASetProperty @http, 'AllowGzip', 0

    -- Send a DELETE request to https://www.example.com/deleteSomething
    SELECT @url = 'https://www.example.com/deleteSomething'
    EXEC sp_OAMethod @http, 'HttpNoBody', @success OUT, 'DELETE', @url, @resp
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END

    -- The DELETE request that is sent looks like this.
    -- The empty Accept-Encoding header value means we only want non-compressed responses.

    -- 	DELETE /deleteSomething HTTP/1.1
    -- 	Host: www.example.com
    -- 	Accept: application/json
    -- 	Accept-Encoding: 

    -- Get the response status
    EXEC sp_OAGetProperty @resp, 'StatusCode', @statusCode OUT

    PRINT 'Response status: ' + @statusCode

    -- Get the response body
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @resp


END
GO