Skip to main content
Support - EBSCO Help

How do I utilize Index tags in the EBSCOhost API?

There are a few ways to locate available index tags for a specific database.

1.  Using the SOAP protocol, the response to your Index Method request will return list of databases available to the specified profile.  For each of these databases, a list of available index tags and their descriptions will display in the <dbIndices>section of the response to your Index Method request.

2.Using the Info method of the REST protocol, the response will return list of databases available to the specified profile.For each of these databases, a list of available index tags and their descriptions will display in the <dbIndices> section of the response to your request. The example below is an excerpt which shows the response to a SOAP Index Method or the REST Index Method, including available index tags.

Example:

…<db shortName="aph" longName="Academic Search Premier"> 

             <sortOptions>

                         ... 

             </sortOptions> 

            <dbTags> 

                        ... 

             </dbTags> 

            <dbIndices> 

                        <dbIndex name="ZA" description="Author"/> 

                        <dbIndex name="ZW" description="Author-Supplied Keywords"/> 

                        <dbIndex name="ZO" description="Company Entity"/> 

                        <dbIndex name="ZT" description="Document Type"/> 

                        <dbIndex name="ZZ" description="DUNS Number"/> 

                        <dbIndex name="ZD" description="Entry Date"/> 

                        <dbIndex name="ZG" description="Geographic Terms"/> 

                        ... 

             </dbIndices>... 

 </db>…

3. The list of index tags is also available in the Database Help page in the EBSCOhost interface. While viewing the Choose Databases Screen in the EBSCOhost interface, you may click the More Information link for the specific database and scroll to the Index Browse section for a list of available index tags. The Database Help page is also available when searching the database in the EBSCOhost interface. On the search page, a Database Help link displays as a blue question mark icon, below the Find field and to the right of the database name.Click the Help icon and scroll down to the Index Browse section for a list of available index tags.