SQL Server

Examine HTTP Response Status Code and Text

See more REST Examples

Demonstrates how to examine the HTTP response status code and text when using the REST object. 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 requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

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

    -- We're going to check https://authenticationtest.com/HTTPAuth/
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'authenticationtest.com', @port, @bTls, @bAutoReconnect
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        RETURN
      END

    -- Send a GET request
    DECLARE @responseText nvarchar(4000)
    EXEC sp_OAMethod @rest, 'FullRequestNoBody', @responseText OUT, 'GET', '/HTTPAuth/'
    EXEC sp_OAGetProperty @rest, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        RETURN
      END

    -- The start line of an HTTP response, called the status line, contains the following information:
    -- 
    --     The protocol version, usually HTTP/1.1.
    --     A status code, indicating success or failure of the request. Common status codes are 200, 404, or 302
    --     A status text. A brief, purely informational, textual description of the status code to help a human understand the HTTP message.
    -- 
    -- A typical status line looks like: HTTP/1.1 404 Not Found.

    -- The ResponseStatusCode property contains the integer response code:

    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    PRINT 'Response status code = ' + @iTmp0

    -- The ResponseStatusText property contains the text (if any) that follows the status code on the status line.

    EXEC sp_OAGetProperty @rest, 'ResponseStatusText', @sTmp0 OUT
    PRINT 'Response status text = ' + @sTmp0

    -- In this case, the sample output is:
    -- 
    -- Response status code = 401
    -- Response status text = Unauthorized

    EXEC @hr = sp_OADestroy @rest


END
GO