• Creating an NCBI Web Service Client Project
• SOAP E-Utilities API

Creating an NCBI Web Service Client Project

Walkthrough: Accessing the NCBI E-Utilities Web service from Word macros.

• In Word open Visual Basic Eitor (Alt+F11)
• Add Soap Library reference to project: select Tools->References... menu, check Microsoft Soap Type Library 3.0 and click OK.
• Add form to project: select Insert->UserForm menu
• From the Toolbox, drag a Button to the form
• Double-click the button on form to create an event-handling method for this button.
• In the CommandButton1_Click method enter the following code:

  ' eInfo utility returns a list of available databases Dim soapclient As MSSOAPLib30.SoapClient30 On Error GoTo FAIL Set soapclient = New SoapClient30 soapclient.MSSoapInit "http://eutils.ncbi.nlm.nih.gov/entrez/eutils/soap/eutils.wsdl" ' call NCBI EInfo utility Dim X1 Set X1 = soapclient.run_eInfo_MS("", "", "") MsgBox X1.Context.XML Exit Sub FAIL: MsgBox soapclient.Detail

• Run application.

SOAP E-Utilities API

Below is a list of methods we recommend for use with Microsoft Visual Basic.
SOAP interface provides user with two functionally identical sets of methods.
Methods which name ends with _MS are designed for use with Microsoft Visual Studio and SOAP Toolkit 3.0

Click on parameter to get its description.
Click on method name to see the example of use.

Function run_eGquery_MS( term As String, 
                         tool As String, 
                         email As String 
                       ) As Variant  
                                        
                                        

Function run_eInfo_MS( db As String, 
                       tool As String,
                       email As String
                     ) As Variant
                                      
                                      

Function run_eLink_MS( db As String, 
                       id() As String, 
                       reldate As String, 
                       mindate As String, 
                       maxdate As String, 
                       datetype As String, 
                       term As String, 
                       dbfrom As String, 
                       WebEnv As String, 
                       query_key As String, 
                       cmd As String, 
                       tool As String, 
                       email As String 
                     ) As Variant
                             

Public Function run_eSearch_MS( db As String, 
                                term As String, 
                                WebEnv As String, 
                                query_key As String, 
                                usehistory As String, 
                                tool As String, 
                                email As String, 
                                field As String, 
                                reldate As String, 
                                mindate As String, 
                                maxdate As String, 
                                datetype As String, 
                                retstart As String, 
                                retmax As String, 
                                rettype As String, 
                                sort As String 
                              ) As Variant 
                                        
Public Function run_eSpell_MS( db As String, 
                               term As String, 
                               tool As String, 
                               email As String 
                             ) As Variant 
                                       
Public Function run_eSummary_MS( db As String, 
                                 id As String, 
                                 WebEnv As String, 
                                 query_key As String, 
                                 retstart As String, 
                                 retmax As String, 
                                 tool As String, 
                                 email As String 
                               ) As Variant 
                                           
Public Function run_eFetch_MS( db As String, 
                               id As String, 
                               WebEnv As String, 
                               query_key As String, 
                               tool As String, 
                               email As String, 
                               retstart As String, 
                               retmax As String, 
                               rettype As String, // *rettype for Molecular Biology Databases 
                               strand As String, 
                               seq_start As String, 
                               seq_stop As String, 
                               complexity As String, 
                               report As String 
                             ) As Variant