(SQL Server) Refinitiv World-Check One - Synchronous Screening (POST)

See more Refinitiv Examples

Sends a signed POST request to do simple synchronous screening.

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",
    --     "content-type",
    --     "content-length"
    --   ]
    -- }

    -- Substitute your actual API key and API secret in place of "api-key" and "api-secret"
    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'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'headers[3]', 'content-type'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'headers[4]', 'content-length'

    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 content-type content-length", signature="..."
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    EXEC sp_OASetProperty @http, 'AuthSignature', @sTmp0

    -- Build the following JSON to be sent in the POST request body.

    -- {
    --     "groupId": "{{group-id}}",
    --     "entityType": "ORGANISATION",
    --     "caseId": "",
    --     "providerTypes": [
    --         "WATCHLIST"
    --     ],
    --     "name": "COMPANY NAME",
    --     "nameTransposition": false,
    --     "secondaryFields": [],
    --     "customFields": []
    -- }

    -- Use this online tool to generate code from sample JSON: 
    -- Generate Code to Create JSON

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

    EXEC sp_OAMethod @jsonBody, 'UpdateString', @success OUT, 'groupId', '{{group-id}}'
    EXEC sp_OAMethod @jsonBody, 'UpdateString', @success OUT, 'entityType', 'ORGANISATION'
    EXEC sp_OAMethod @jsonBody, 'UpdateString', @success OUT, 'caseId', ''
    EXEC sp_OAMethod @jsonBody, 'UpdateString', @success OUT, 'providerTypes[0]', 'WATCHLIST'
    EXEC sp_OAMethod @jsonBody, 'UpdateString', @success OUT, 'name', 'COMPANY NAME'
    EXEC sp_OAMethod @jsonBody, 'UpdateBool', @success OUT, 'nameTransposition', 0
    EXEC sp_OAMethod @jsonBody, 'UpdateNewArray', @success OUT, 'secondaryFields'
    EXEC sp_OAMethod @jsonBody, 'UpdateNewArray', @success OUT, 'customFields'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api-worldcheck.refinitiv.com/v2/cases/screeningRequest', 'application/json', @jsonBody
    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
        EXEC @hr = sp_OADestroy @jsonBody
        RETURN
      END


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

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

    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @jsonResp, 'Load', @success OUT, @sTmp0

    EXEC sp_OASetProperty @jsonResp, 'EmitCompact', 0
    EXEC sp_OAMethod @jsonResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- Use this online tool to generate parsing code from sample JSON: 
    -- Generate Parsing Code from JSON

    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @jsonBody
    EXEC @hr = sp_OADestroy @jsonResp


END
GO