SQL Server

effectconnect Read Orderlist

See more effectconnect Examples

Get a set of orders filtered by the parameters in the XML payload. 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 @sTmp1 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 @fullUri nvarchar(4000)
    SELECT @fullUri = 'https://submit.effectconnect.com/orderlist'
    DECLARE @uri nvarchar(4000)
    SELECT @uri = '/orderlist'
    DECLARE @apiVersion nvarchar(4000)
    SELECT @apiVersion = '2.0'

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

    -- Use your effectconnect public key here..
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'KEY', 'PUBLIC_KEY'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'VERSION', @apiVersion
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'URI', @uri
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'RESPONSETYPE', 'XML'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'RESPONSELANGUAGE', 'en'

    -- Get the current date/time in timestamp format.
    DECLARE @dt int
    EXEC @hr = sp_OACreate 'Chilkat.CkDateTime', @dt OUT

    EXEC sp_OAMethod @dt, 'SetFromCurrentSystemTime', @success OUT
    DECLARE @timestamp nvarchar(4000)
    EXEC sp_OAMethod @dt, 'GetAsTimestamp', @timestamp OUT, 1

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'TIME', @timestamp

    PRINT 'timestamp = ' + @timestamp

    -- Create the following XML request body:
    -- <?xml version="1.0" encoding="utf-8"?>
    -- <list>
    --   <filters>
    --     <fromDateFilter>
    --       <filterValue>2018-09-14T12:12:12+01:00</filterValue>
    --     </fromDateFilter>
    --     <toDateFilter>
    --       <filterValue>2019-04-13T23:59:59+01:00</filterValue>
    --     </toDateFilter>
    --     <hasStatusFilter>
    --       <filterValue>paid</filterValue>
    --     </hasStatusFilter>
    --     <hasTagFilter>
    --       <filterValue>
    --         <tagName>Test</tagName>
    --         <exclude>false</exclude>
    --       </filterValue>
    --     </hasTagFilter>
    --   </filters>
    -- </list>

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

    DECLARE @xml int
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xml OUT

    EXEC sp_OASetProperty @xml, 'Tag', 'list'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'filters|fromDateFilter|filterValue', '2018-09-14T12:12:12+01:00'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'filters|toDateFilter|filterValue', '2019-04-13T23:59:59+01:00'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'filters|hasStatusFilter|filterValue', 'paid'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'filters|hasTagFilter|filterValue|tagName', 'Test'
    EXEC sp_OAMethod @xml, 'UpdateChildContent', NULL, 'filters|hasTagFilter|filterValue|exclude', 'false'
    EXEC sp_OASetProperty @xml, 'EmitCompact', 1

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

    EXEC sp_OAMethod @xml, 'GetXmlSb', @success OUT, @sbXml

    -- Build a string-to-sign and sign it using our effectconnect private key
    DECLARE @sbStringToSign int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbStringToSign OUT

    EXEC sp_OAGetProperty @sbXml, 'Length', @iTmp0 OUT
    EXEC sp_OAMethod @sbStringToSign, 'AppendInt', @success OUT, @iTmp0
    EXEC sp_OAMethod @sbStringToSign, 'Append', @success OUT, 'POST'
    EXEC sp_OAMethod @sbStringToSign, 'Append', @success OUT, @uri
    EXEC sp_OAMethod @sbStringToSign, 'Append', @success OUT, @apiVersion
    EXEC sp_OAMethod @sbStringToSign, 'Append', @success OUT, @timestamp

    DECLARE @crypt int
    EXEC @hr = sp_OACreate 'Chilkat.Crypt2', @crypt OUT

    EXEC sp_OASetProperty @crypt, 'MacAlgorithm', 'hmac'
    EXEC sp_OASetProperty @crypt, 'HashAlgorithm', 'sha512'
    EXEC sp_OASetProperty @crypt, 'EncodingMode', 'base64'
    -- Use your effectconnect private key here:
    EXEC sp_OAMethod @crypt, 'SetMacKeyString', @success OUT, 'PRIVATE_KEY'
    EXEC sp_OAMethod @sbStringToSign, 'GetAsString', @sTmp1 OUT
    EXEC sp_OAMethod @crypt, 'MacStringENC', @sTmp0 OUT, @sTmp1
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'SIGNATURE', @sTmp0

    -- Send the POST..
    DECLARE @resp int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    EXEC sp_OAMethod @xml, 'GetXml', @sTmp0 OUT
    EXEC sp_OAMethod @http, 'HttpStr', @success OUT, 'POST', @fullUri, @sTmp0, 'utf-8', 'application/xml', @resp
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @dt
        EXEC @hr = sp_OADestroy @xml
        EXEC @hr = sp_OADestroy @sbXml
        EXEC @hr = sp_OADestroy @sbStringToSign
        EXEC @hr = sp_OADestroy @crypt
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END


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

    -- Examine the response.  The response status code can be 200 for both errors and success.
    -- The success or error is based on the XML returned in the response body.
    DECLARE @xmlResp int
    EXEC @hr = sp_OACreate 'Chilkat.Xml', @xmlResp OUT

    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @xmlResp, 'LoadXml', @success OUT, @sTmp0


    PRINT 'response body:'
    EXEC sp_OAMethod @xmlResp, 'GetXml', @sTmp0 OUT
    PRINT @sTmp0

    -- Remove previously set headers (unless we want the same headers for the next request,
    -- in which case we may remove or update individual headers by calling SetRequestHeader.
    EXEC sp_OAMethod @http, 'ClearHeaders', NULL

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @dt
    EXEC @hr = sp_OADestroy @xml
    EXEC @hr = sp_OADestroy @sbXml
    EXEC @hr = sp_OADestroy @sbStringToSign
    EXEC @hr = sp_OADestroy @crypt
    EXEC @hr = sp_OADestroy @resp
    EXEC @hr = sp_OADestroy @xmlResp


END
GO