(SQL Server) Refinitiv World-Check One - Archive Case (PUT)

See more Refinitiv Examples

Sends a signed PUT request to archive a case.

Note: This example requires Chilkat v9.5.0.89 or later.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- 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 assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- Create the following JSON:
    -- 
    -- {
    --   "keyId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    --   "hmacKey": "xxxxzI3vi58xxxCBxxx1+P/d8tGxx7KuLqN/KMPNxxxxekhj8/bx83+1YQSUxxxxYyv939ceY06GvhYRKmxxxx==",
    --   "algorithm": "hmac-sha256",
    --   "headers": [
    --     "(request-target)",
    --     "host",
    --     "date",
    --   ]
    -- }

    -- Substitute your actual API key and API secret in place of "api-key" and "api-secret"
    -- Note: This particular API call is a PUT with an empty request body.
    -- Because the request body is empty, we don't include the content-type and content-length headers.
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'keyId', 'api-key'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'hmacKey', 'api-secret'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'algorithm', 'hmac-sha256'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'headers[0]', '(request-target)'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'headers[1]', 'host'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'headers[2]', 'date'

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT

    -- Setting the AuthSignature property causes the following header to be computed and added:
    -- Authorization: Signature keyId="...", algorithm="hmac-sha256", headers="(request-target) host date", signature="..."
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    EXEC sp_OASetProperty @http, 'AuthSignature', @sTmp0

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PText', @resp OUT, 'PUT', 'https://api-worldcheck.refinitiv.com/v2/cases/{{case-system-id}}/archive', '', '', '', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @http
        RETURN
      END


    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT 'Response status code = ' + @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0

    -- If successful, the response status code will equal 204, and the response body will be empty JSON "{}"

    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @http


END
GO