{"id":7317,"date":"2019-06-29T09:34:55","date_gmt":"2019-06-29T09:34:55","guid":{"rendered":"https:\/\/zappysys.com\/blog\/?p=7317"},"modified":"2024-01-17T11:26:44","modified_gmt":"2024-01-17T11:26:44","slug":"export-rest-api-ms-access-using-vba-command-button","status":"publish","type":"post","link":"https:\/\/zappysys.com\/blog\/export-rest-api-ms-access-using-vba-command-button\/","title":{"rendered":"How to Export REST API to MS Access using VBA Command Button"},"content":{"rendered":"

Introduction<\/span><\/h2>\n

\"VBA\"<\/a>In our previous blog we saw how to export REST API to CSV using c# or Python<\/a>. In this post we will look at specific example on How to Export REST API to MS Access using VBA Command Button<\/strong>, along with few other topics such as how to make REST API Call<\/strong>, how to read all Customers data from Odata using our ODBC JSON Driver and load it into the Ms Access Table.<\/p>\n

We will go through the steps to read data from Odata and Load into MS Access using\u00a0VBA Command Button.<\/p>\n

In nutshell,\u00a0this post will focus on how to make ODBC Driver Call using VBA.<\/p>\n

So let\u2019s get started.<\/p>\n

Requirements<\/span><\/h2>\n
    \n
  1. First of all, you will need\u00a0ZappySys ODBC PowerPack<\/a>\u00a0installed.<\/li>\n
  2. Secondly, Make sure that Microsoft Access installed for VBA example.<\/li>\n<\/ol>\n

    An introduction to Rest API and OData<\/span><\/h2>\n

    In this example, we will use OData (Open Data Protocol) to consume REST API. REST API\u00a0(Representational State Transfer Application Program Interface) allows handling the interoperability between computers and the internet.<\/p>\n

    In REST API we can handle web services in different formats. In this example, we will work with the Northwind example. The Northwind example is available in this URL:<\/p>\n

    \n
    \n
    https:\/\/services.odata.org\/V3\/Northwind\/Northwind.svc<\/pre>\n<\/div>\n<\/div>\n
      \n
    1. By default, the data is displayed in XML format. To show the data in JSON use this URL:\n
      https:\/\/services.odata.org\/V3\/Northwind\/Northwind.svc\/?$format=json<\/pre>\n<\/li>\n
    2. There are collections of data like Categories, CustomerDemographic, Customers, Invoices, etc. For example, the following URL will show the data of the categories collection:\n
      https:\/\/services.odata.org\/V3\/Northwind\/Northwind.svc\/Customers?$format=json<\/pre>\n<\/li>\n
    3. In the next steps, we will use ZappySys drivers to connect to this URL and query using OData.<\/li>\n<\/ol>\n
      Configure ODBC DSN for ZappySys JSON Driver<\/span><\/h2>\n
      ODBC driver can be accessed in two modes.<\/p>\n
        \n
      1. Using DSN<\/li>\n
      2. Without DSN (Supply direct Connection String e.g.\u00a0DRIVER={ZappySys JSON Driver}; \u2026\u2026..<\/strong>\u00a0)<\/li>\n<\/ol>\n
        In this article, we will use the DSN approach (User DSN).\u00a0We will first add the ZappySys JSON Driver in the ODBC Data Source Administrator.<\/p>\n
        Follow these steps to accomplish the task:<\/p>\n
          \n
        1. First,\u00a0Windows search<\/strong>, write\u00a0ODBC<\/strong>\u00a0and select the\u00a0ODBC Data sources (32 bits)<\/strong>\n
        2. As a second step, in ODBC Data source Administrator press the\u00a0Add<\/strong>\u00a0button.\n
        3. In this step, create the new data source, select\u00a0ZappySys JSON Driver.<\/strong>\n
        4. Here we have several properties, write a data source name. In this example, the name will be ZappySys JSON to Excel.<\/li>\n
        5. The Data Source (URL or file path) can specify the URL of the source or if it is a local file, you can specify the local path. In this example, the URL is:\n
          https:\/\/services.odata.org\/V3\/Northwind\/Northwind.svc\/Customers?$format=json<\/pre>\n
          You can also specify a local file path as Data SourceFor a single file:\u00a0 c:\\data\\myfile_1.json
          \nFor multiple files: c:\\data\\myfile_*.json<\/li>\n
        6. Configure the ODBC JSON Driver like this and test the connection:\n
        7. Now click on Copy Connection string Button.\n
        8. That’s it Connection string is copied to clipboard. Now let’s use this connection string in the VBA code.<\/li>\n<\/ol>\n
          How to import REST API data to Access using VBA<\/span><\/h2>\n
            \n
          1. Open the access database and create the table with the desire columns to get API data in it.\n
          2. Now close the table, and go to Create menu and click on Form Design to add the new blank form in design view.\n
          3. It will open the new form in the design view, now add new button with the desire text.\n
          4. Now right click on button and go to properties and click on … builder button and select Code Builder.\n
          5. When you click the button, it will open a new VBA instance, executing the command event associated with that button click.
            \nNext, insert the provided code inside the Command5_Click()<\/i> function. In this example, the button is named Command5, and that’s why it’s added within this click function.
            \nThe provided code encompasses the following steps:<\/p>\n
              \n
            1. Ensure the table is closed:<\/strong>
              \nIt’s crucial to close the table beforehand; otherwise, executing the subsequent command may result in an error.<\/li>\n
            2. Truncate the table:
              \n<\/strong>Clear the existing data from the table. If you want to add fresh data each time<\/li>\n
            3. Make the API call:
              \n<\/strong>Utilize the ODBC Driver connection string to initiate an API call.<\/li>\n
            4. Insert into the Access table:
              \n<\/strong>Use the retrieved data from the API call to insert new records into the Access table.<\/li>\n
            5. Open the table:
              \n<\/strong>Reopen the table to inspect the newly inserted data.<\/li>\n<\/ol>\n
                  ' Pass your ZappySys Driver Connection String: Refer to below link to learn how to obtain the ZappySys Driver connection string:\r\n    ' https:\/\/community.zappysys.com\/t\/how-to-copy-the-zappysys-driver-connection-string\/172\r\n    Dim zsConnStr As String\r\n    zsConnStr = \"DRIVER={ZappySys JSON Driver};DataPath='https:\/\/services.odata.org\/V3\/Northwind\/Northwind.svc\/Customers?$format=json';Filter='$.value[*]';IncludeParentColumns=0;RequestMethod='GET';RequestHeaders='cache-control: no-cache || Accept: *\/*'\"\r\n        \r\n    'ZappySys Driver Query\r\n    Dim zsDriverQuery As String\r\n    zsDriverQuery = \"Select * from $\"\r\n \r\n    'MS Access Table Name\r\n    Dim tableName As String\r\n    tableName = \"tblCustomers\"\r\n\r\n    ' 1. Close Table If Open\r\n    CloseTableIfOpen tableName\r\n\r\n    ' 2. Truncate Table (Optional): If you want to load fresh data each time, uncomment the line below.\r\n    'TruncateTable tableName\r\n\r\n    ' 3. Import Data From API Into Table\r\n    ImportDataFromAPIIntoTable zsConnStr, zsDriverQuery, tableName\r\n\r\n    ' 4. Open Table for Viewing (Optional)\r\n    OpenTableForViewing tableName\r\n\r\n    ' Show Message after Loading Data Successfully\r\n    MsgBox \"Data Loaded Successfully!\"\r\n<\/pre>\n
              \"ms-access-vba-button-onclick\"<\/a>
              VBA Button OnClick Function<\/p><\/div>\n
               <\/li>\n
            6. Below the Private Sub Command5_Click()<\/i> function, please add the necessary functions and procedures as provided below:\n
              Sub ImportDataFromAPIIntoTable(zsConnStr As String, zsDriverQuery As String, tableName As String)\r\n    Dim dscn As New ADODB.Connection\r\n    dscn.Open zsConnStr\r\n\r\n    Dim rs As Object\r\n    Set rs = New ADODB.Recordset\r\n    \r\n    ''ZappySys Driver Query Goes here\r\n    rs.Open zsDriverQuery, dscn\r\n\r\n    Dim strQuery As String\r\n    strQuery = \"\"\r\n    ' Check if the recordset is not empty\r\n    If Not rs.EOF Then\r\n        ' Get the field names\r\n        Dim fieldNames As String\r\n        fieldNames = \"\"\r\n\r\n        For i = 1 To rs.Fields.Count\r\n            fieldNames = fieldNames & rs.Fields(i - 1).Name\r\n            If i < rs.Fields.Count Then\r\n                fieldNames = fieldNames & \",\"\r\n            End If\r\n        Next i\r\n\r\n        ' Generate the INSERT script\r\n        Dim insertScript As String\r\n        ' Iterate through the recordset to get the values\r\n        Do Until rs.EOF\r\n            ' Generate Insert script\r\n            insertScript = \"INSERT INTO \" & tableName & \" (\" & fieldNames & \") VALUES\"\r\n            insertScript = insertScript & vbCrLf & \"(\"\r\n            For i = 1 To rs.Fields.Count\r\n                ' Assuming all fields are text, you might need to handle different data types appropriately\r\n                \r\n                If IsNull(rs.Fields(i - 1).Value) Then\r\n                    insertScript = insertScript & \"''\"\r\n                Else\r\n                    insertScript = insertScript & \"'\" & EscapeSingleQuote(rs.Fields(i - 1).Value) & \"'\"\r\n                End If\r\n                \r\n                \r\n                If i < rs.Fields.Count Then\r\n                    insertScript = insertScript & \",\"\r\n                End If\r\n            Next i\r\n            insertScript = insertScript & \")\"\r\n            \r\n            'Insert data\r\n            CurrentProject.Connection.Execute insertScript\r\n            \r\n            rs.MoveNext\r\n        Loop\r\n    End If\r\n    \r\n    ' Close the recordset and connection\r\n    rs.Close\r\n    dscn.Close\r\n    Set rs = Nothing\r\n    Set conn = Nothing\r\n    \r\nEnd Sub\r\n\r\nSub OpenTableForViewing(tableName As String)\r\n    If Not IsTableOpen(tableName) Then\r\n        DoCmd.OpenTable tableName\r\n    End If\r\nEnd Sub\r\n\r\nPublic Function IsTableOpen(strName As String) As Boolean\r\n     IsTableOpen = SysCmd(acSysCmdGetObjectState, acTable, strName)\r\nEnd Function\r\n\r\nSub CloseTableIfOpen(tableName As String)\r\n    If IsTableOpen(tableName) Then\r\n        DoCmd.SelectObject acTable, tableName\r\n        DoCmd.RunCommand acCmdSaveRecord\r\n        DoCmd.Close\r\n    End If\r\nEnd Sub\r\n\r\n\r\nSub TruncateTable(tableName As String)\r\n    Dim strSql As String\r\n    strSql = \"DELETE FROM \" & tableName & \";\"\r\n    CurrentProject.Connection.Execute strSql\r\nEnd Sub\r\n\r\nPublic Function EscapeSingleQuote(strData As String) As String\r\n     EscapeSingleQuote = Replace(strData, \"'\", \"''\")\r\nEnd Function\r\n<\/pre>\n<\/li>\n
            7. Now, save the VBA form code and provide some appropriate form names.\n
            8. Make sure to add the reference to the Microsoft ActiveX Data Objects X.0 Library in the project settings.In Microsoft Access VBA,
              \nYou can add the reference to the Microsoft ActiveX Data Objects X.0 Library by following these steps:<\/p>\n
                \n
              1. In the VBA editor, go to “Tools” in the menu and select “References.”<\/li>\n
              2. In the References dialog box, scroll down the list to find “Microsoft ActiveX Data Objects X.0 Library” (where “X.0” corresponds to the version number, such as 6.1, 2.8, etc.).<\/li>\n
              3. Check the box next to the appropriate version to enable the reference.<\/li>\n
              4. Click “OK” to save the changes and close the References dialog box.<\/li>\n<\/ol>\n
                Now, your Access project has a reference to the Microsoft ActiveX Data Objects library, and you can use its features in your VBA code.<\/p>\n
              5. Close the code project, open the form in Form View, and click on the button.\n
              6. After clicking the button, it will initiate a REST API call, insert the data into the Access table, and open the table to display the inserted records along with a success message.\n
                \"Access<\/a>
                Access : Open the table<\/p><\/div><\/li>\n<\/ol>\n
                Troubleshooting Errors<\/h2>\r\n
                While running in Access\\Excel\\other and reading data from DSN created with ODBC PowerPack, if you get this error \"License type [ODBC_PP_TRIAL] not found or its expired<\/strong>\"<\/p>\r\n\r\n
                Please refer to this article for the same:\u00a0\u00a0Troubleshooting \"License type [ODBC_PP_TRIAL] not found or its expired\" error in Microsoft Access<\/a><\/p><\/div>\n
                Conclusion<\/span><\/h2>\n
                In this article, we saw how to use VBA to call REST API. We show how to do REST API calls in Access using the ZappySys ODBC driver. Also, we show how to write VBA Code in MS Access for command button to make REST API call, truncate access table and insert record in the access table using VBA code. If you liked this\u00a0article and you want to try, you can download the\u00a0ZappySys ODBC\u00a0installer here<\/a>.<\/p>\n
                References<\/span><\/h2>\n