Browse

The Browse method is used to view indexes such as Authors or Subject Terms on an EBSCOhost database. Note that the index availability can be different per database. To test this method with your EIT profile, visit the EBSCOhost Web Service Browse method page.

Note: This method is not supported when using a Discovery Service 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 EIT Web Service API's Browse method. To see more information on either the REST or SOAP protocol with the EIT Web Service, 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. -
term Term Term(s) to browse. Yes -
db Databases One short database name to browse.

Click here for a list of databases supported by EIT.
Yes. -
index Index The index used for the browse. Note that the different indexes are available per database, please use the Info method for a list of indexes per database.

Yes > 0
numrec NumberRecordsReturned Number of records returned from a search (if available). Note that the maximum number of records returned is 50 when a 'full' record format is specified.

Default: 20
No > 0,
< 200
* When using the SOAP API, these items must be in the AuthorizationHeader of the request. See Making Requests with SOAP for more information on how to form the AuthorizationHeader.

Output Format

Hide | Back to Top

This is the expected output of the Search function:

<browseResponse>
  <response>
    <records>
      <!-- N - number of rec elements -->
      <rec resultID="xs:int">
        <header>
          <browseTerms searchKey="xs:string" count="xs:int">
            <browseTerm>
              <!-- Browse Term -->
            </browseTerm>
          </browseTerms>
        </header>
      </rec>
    </records>
  </response>
</browseResponse>
	

Viewing: Simplified Response | Real Response

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

There will be N <rec> nodes, one per browse record returned. All of the record nodes are within the <response>/<records> node. The information about each record is contained in the <header> node within each <rec> node. The <browseTerms> node format is as follows:

<browseTerms searchKey="xs:string" count="xs:int">
  <browseTerm> <!-- Browse Term --> </browseTerm>
</browseTerms>

The searchKey is the term returned, and count is the number of results for that term. The <browseTerm> node contains the name of the term.

REST Sample

Hide | Back to Top

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

Call:
http://eit.ebscohost.com/Services/SearchService.asmx/Browse?
	prof=[Your EIT Profile ID]
	&pwd=[Your Profile Password]
	&term=[Term to Browse]
	&index=[Index to Browse]
	&db=[Database to Browse]
Response:
<browseResponse>
  <response>
    <records>
      <rec resultID="xs:int">
        <header>
          <browseTerms searchKey="xs:string" count="xs:int">
            <browseTerm> </browseTerm>
          </browseTerms>
        </header>
      </rec>
    </records>
  </response>
</browseResponse>

SOAP Sample

Hide | Back to Top

This is a sample of the Search 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:Search xmlns:eit="http://epnet.com/webservices/SearchService/2007/07/">
      <eit:searchRequest>
        <eit:Term>[Term to Browse for]</eit:Query>
        <eit:Index>[Index to Browse]</eit:Query>
        <eit:Databases>[Database to Browse]</eit:Databases>
      </eit:searchRequest>
    </eit:Search>
  </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>
    <BrowseResponse xmlns="http://epnet.com/webservices/SearchService/2007/07/">
      <browseResponse>
        <response>
          <records>
            <rec resultID="xs:int">
              <header>
                <browseTerms searchKey="xs:string" count="xs:int">
                  <browseTerm> </browseTerm>
                </browseTerms>
              </header>
            </rec>
          </records>
        </response>
      </browseResponse>
    </BrowseResponse>
  </soap:Body>
</soap:Envelope>