Info

The Info method allows the customer to receive a list of databases available to the given profile as well as the attributes of those databases such as the sort fields and indexes allowed by each database.

To test this method with your EIT profile, visit the EBSCOhost API Info method page.

Note: This method is not supported when using an EBSCO Discovery Service (EDS) profile. Click here for more information.

Input Parameters

Hide | Back to Top

These are the input parameters for both the REST and SOAP protocols of the EBSCOhost API Info method. To see more information on either the REST or SOAP protocol with the EBSCOhost API, see:

The REST and SOAP protocols will return the same results, but the parameter names are different. Parameter names for the REST protocol are listed under the "REST" column, and parameter names for the SOAP protocol are listed under the "SOAP" column.

REST
SOAP
Description
Required
Values
prof Profile* The profile used for authentication. This must be an EIT enabled profile. Required if using profile authentication. -
pwd Password* The password used for profile authentication. Required if using profile authentication. -
authType AuthType* Indicates if using IP Authentication or Profile Authentication.

Default: profile
No profile,
ip
ipprof IpProfile* The profile used for authentication. Required if using IP authentication. -
- IpAddress* The IP address used for authentication. Required if using IP authentication. -

Output Format

Hide | Back to Top

This is the expected output of the Info function:

<info shortName="xs:string"  longName="xs:string"  dbType="xs:string"  contentType="xs:string" outsideSource="xs:string" >
  <dbInfo>
    <!-- N number of db elements, one per database available to profile -->
    <db shortName="xs:string" longName="xs:string" >
      <sortOptions>
        <sort name="xs:string"  id="xs:string" >
        </sort>
      </sortOptions>
      <dbTags>
        <dbTag name="xs:string"  description="xs:string" >
        </dbTag>
      </dbTags>
      <dbIndices>
        <dbIndex name="xs:string"  description="xs:string" >
        </dbIndex>
      </dbIndices>
      <dbFormats>
        <dbFormat name="xs:string"  description="xs:string" >
        </dbFormat>
      </dbFormats>
      <authorityInfo>
        <!-- N number of db elements, one per authority database available to current database. -->
        <db>
          <!-- Each db element may also contain sortOptions, dbTags, dbIndices, or dbFormats -->
        </db>
      </authorityInfo>
    </db>
  </dbInfo>
</info>

Viewing: Simplified Response | Real Response

Upon success, the first node returned should be the <info> node (note: in SOAP, this node is contained within the Envelope/Body/InfoResponse node). If there was an error, then the first node returned would be the <Fault> node.

This Info method will return all databases available to a given profile. All of the databases are returned within the <dbInfo> node. Each database itself is represented with a <db> node. The <db> node contains the following attributes:

  • shortName - database code such as: a9h or bch
  • longName - full name of the database
  • outsideSource - boolean value (true/false) indicating whether the database is a non-EBSCO database accessible via an EBSCOhost Integrated Search connector
  • contentType - Not Specified for regular databases. Flat Subject, MESH, Multimedia/Images, Multimedia/Videos or Thesaurus for authority databases
  • dbType - Regular for non-authority databases. Otherwise: Flat Authority or Regular As Authority

In each <db> node, information about the database is given. The information given is:

  • Sort Options
  • Indices
  • Tags
  • Formats
  • Authority Databases

The <sortOptions> node contains the fields which can be used to sort database searches. Each database has a different set of sort options available to it. Within the <sortOptions> node, there may be several <sort> nodes:

<sort name="xs:string" id="xs:string >

name is the name used to describe the sort option, and id is the id used to refer to the sort option when making a search query.

The <dbTags> node contains the tags which can be used for searching the database. The tags are represented by <dbTag> within the <dbTags> node:

<dbTags name="xs:string" description="xs:string >

name is the id used to refer to the tag when searching, and description is the description of the tag.

The same format applies for the <dbIndices> and <dbFormats> nodes as well. The <dbIndicies> node lists out the available indices to search on the database, and the <dbFormats> lists the available record formats of the database.

The <authorityInfo> node contains authority databases available to the database. The <authorityInfo> node contains <db> nodes, which represent each authority database. The <db> nodes representing authority databases can have Sort Options, Indices, Tags, and Formats, much like normal databases.

REST Sample

Hide | Back to Top

This is a sample of the Info method using the REST protocol.

Call:
http://eit.ebscohost.com/Services/SearchService.asmx/Info?
	prof=[Your EIT Profile ID]
	&pwd=[Your Profile Password]
Response:
<?xml version="1.0">
<info shortName="xs:string"  longName="xs:string"  dbType="xs:string"  contentType="xs:string"  outsideSource="xs:string" >
  <dbInfo>
    <db shortName="xs:string" longName="xs:string" >
      <sortOptions>
        <sort name="xs:string"  id="xs:string" >
        </sort>
      </sortOptions>
      <dbTags>
        <dbTag name="xs:string"  description="xs:string" >
        </dbTag>
      </dbTags>
      <dbIndices>
        <dbIndex name="xs:string"  description="xs:string" >
        </dbIndex>
      </dbIndices>
      <dbFormats>
        <dbFormat name="xs:string"  description="xs:string" >
        </dbFormat>
      </dbFormats>
      <authorityInfo>
        <db>
        </db>
      </authorityInfo>
    </db>
  </dbInfo>
</info>

SOAP Sample

Hide | Back to Top

This is a sample of the Info methods output using the SOAP protocol.

Call:
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" >
  <soap:Header>
    <eit:AuthorizationHeader soap:mustUnderstand="1" xmlns:eit="http://epnet.com/webservices/SearchService/2007/07/">
      <eit:Profile>[Your EIT Profile ID]</eit:Profile>
      <eit:Password>[Your  Profile Password]</eit:Password>
    </eit:AuthorizationHeader>
  </soap:Header>
  <soap:Body>
    <eit:Info xmlns:eit="http://epnet.com/webservices/SearchService/2007/07/">
    </eit:Info>
  </soap:Body>
</soap:Envelope>
				


Response:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <InfoResponse xmlns="http://epnet.com/webservices/SearchService/2007/07/">
      <info shortName="xs:string"  longName="xs:string"  dbType="xs:string"  contentType="xs:string" outsideSource="xs:string" >
        <dbInfo>
          <db shortName="xs:string" longName="xs:string" >
            <sortOptions>
              <sort name="xs:string"  id="xs:string" >
              </sort>
            </sortOptions>
            <dbTags>
              <dbTag name="xs:string"  description="xs:string" >
              </dbTag>
            </dbTags>
            <dbIndices>
              <dbIndex name="xs:string"  description="xs:string" >
              </dbIndex>
            </dbIndices>
            <dbFormats>
              <dbFormat name="xs:string"  description="xs:string" >
              </dbFormat>
            </dbFormats>
            <authorityInfo>
              <db>
              </db>
            </authorityInfo>
          </db>
        </dbInfo>
      </info>
    </InfoResponse>
  </soap:Body>
</soap:Envelope>