SQL Server

Xero Get Folders (Files API)

Demonstrates how to retrieve the list of folders.

Note: This example requires Chilkat v9.5.0.64 or greater.

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

    -- Note: Requires Chilkat v9.5.0.64 or greater.

    -- This 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

    -- Before sending REST API calls, the REST object needs to be
    -- initialized for OAuth1.
    -- See Xero 2-Legged OAuth1 Setup for sample code.

    -- Assuming the REST object's OAuth1 authenticator is setup, and the initial
    -- connection was made, we may now send REST HTTP requests..

    -- Get the full list of folders (in the FILES API)
    DECLARE @sbJson int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJson OUT

    EXEC sp_OAMethod @rest, 'FullRequestNoBodySb', @success OUT, 'GET', '/files.xro/1.0/Folders', @sbJson
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @sbJson
        RETURN
      END

    -- The response is a JSON array.
    DECLARE @jsonArr int
    EXEC @hr = sp_OACreate 'Chilkat.JsonArray', @jsonArr OUT

    EXEC sp_OAMethod @jsonArr, 'LoadSb', @success OUT, @sbJson
    EXEC sp_OASetProperty @jsonArr, 'EmitCompact', 0

    -- A 200 response is expected for actual success.
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN
        EXEC sp_OAMethod @jsonArr, 'Emit', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @sbJson
        EXEC @hr = sp_OADestroy @jsonArr
        RETURN
      END

    EXEC sp_OAMethod @jsonArr, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- The JSON list of folders looks like this:
    -- See the code below showing how to iterate over the folders..

    -- 	[
    -- 	  { 
    -- 	    "Name": "Inbox",
    -- 	    "FileCount": 0,
    -- 	    "Email": "xero.inbox.bt0xx.99ha3l7a28m7ghyn@xerofiles.com",
    -- 	    "IsInbox": true,
    -- 	    "Id": "de386667-2532-49d3-8ad8-b7727b128ea2"
    -- 	  },
    -- 	  { 
    -- 	    "Name": "Contracts",
    -- 	    "FileCount": 0,
    -- 	    "IsInbox": false,
    -- 	    "Id": "36f15a6e-74f3-42fd-8797-e288b9aae234"
    -- 	  },
    -- 	  { 
    -- 	    "Name": "Images",
    -- 	    "FileCount": 0,
    -- 	    "IsInbox": false,
    -- 	    "Id": "0ffca059-f2f1-4271-8de9-4b87c8c2c638"
    -- 	  }
    -- 	]

    DECLARE @i int
    SELECT @i = 0
    DECLARE @numFolders int
    EXEC sp_OAGetProperty @jsonArr, 'Size', @numFolders OUT
    WHILE @i < @numFolders
      BEGIN
        DECLARE @json int
        EXEC sp_OAMethod @jsonArr, 'ObjectAt', @json OUT, @i

        EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'Name'
        PRINT 'Name: ' + @sTmp0

        EXEC sp_OAMethod @json, 'IntOf', @iTmp0 OUT, 'FileCount'
        PRINT 'FileCount: ' + @iTmp0

        EXEC sp_OAMethod @json, 'BoolOf', @iTmp0 OUT, 'IsInbox'
        PRINT 'IsInbox: ' + @iTmp0

        EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'Id'
        PRINT 'Id: ' + @sTmp0

        PRINT '--'
        EXEC @hr = sp_OADestroy @json

        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @sbJson
    EXEC @hr = sp_OADestroy @jsonArr


END
GO