AuthoritySearch

The AuthoritySearch method is used to perform authority searches on EBSCOhost databases. To test this method with your EIT profile, visit the EBSCOhost API AuthoritySearch method page.

Note: This method is not supported when using a 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 AuthoritySearch 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. -
query Query Terms to be searched on. Yes -
db Authority_x0020_Database One short authority database name to search.

Click here for a list of databases supported by EIT.
Yes. -
mode SearchMode The authority search mode.

Default: relevancy
Yes. relevancy, alphabetic, boolean, termcontains
startrec StartingRecordNumber Starting record number for the result set returned from a search.

Default: 1
No > 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: 10
No > 0,
< 200
sort Sort The sort order for the search results. Note that the different sort options are database specific, please use the Info method for a list of sort options per database.

Default: date
No -
format RecordFormat The format of the results' records.

Default: brief
No brief,
detailed,
full
* 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 AuthoritySearch function:

<AuthoritySearchResponse>
   <Statistics>
      <!-- N-number of Statistic elements, one per database used during the search -->
      <Statistic>
         <Database>
            <!-- Database Short Name -->
         </Database>
         <Hits>
            <!-- Number of hits found for the query within the database -->
         </Hits>
      </Statistic>
   </Statistics>
   <SearchResults>
      <records>
      <!N-number of rec element, one per record returned from the search -->
         <rec recordID="xs:int">
         <!-- The exact structure will depend on a number of factors including the format used and authority searched -->
         <!-- Below is a list of more commonly used data items -->
            <browseTerm> <!-- Browse Term --> </browseTerm>
            <searchTag> <!-- Search Tag --> </searchTag>
            <searchTerm> <!- Search Term --> </searchTerm>
            <useTerm> <!- Use Term --> </useTerm>
            <isExplodable> <!- Term can be exploded (Y/N) --> </isExplodable>
         </rec>
      </records>
   </SearchResults>
</AuthoritySearchResponse>

Viewing: Simplified Response | Real Response

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

The <Statistics> node contains the number of records returned from the authority database searched. It will contain one <Statistic> node containing the information.

If the query was sucessful and returned results, the next node should be the <SearchResults> node. This node contains all of the individual search results. Each record is returned in a <rec> node, within the <records> node. An AuthoritySearch query will return X number of <rec> nodes, where X is the number of search results returned.

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/Search?
	prof=[Your EIT Profile ID]
	&pwd=[Your Profile Password]
	&query=[Your Search Query]
	&db=[Authority Database to Search]
Response:
<?xml version="1.0">
<AuthoritySearchResponse>
   <Statistics>
      <!-- N-number of Statistic elements, one per database used during the search -->
      <Statistic>
         <Database>
            <!-- Database Short Name -->
         </Database>
         <Hits>
            <!-- Number of hits found for the query within the database -->
         </Hits>
      </Statistic>
   </Statistics>
   <SearchResults>
      <records>
      <!N-number of rec element, one per record returned from the search -->
         <rec recordID="xs:int">
         <!-- The exact structure will depend on a number of factors including the format used and authority searched -->
         <!-- Below is a list of more commonly used data items -->
            <browseTerm> <!-- Browse Term --> </browseTerm>
            <searchTag> <!-- Search Tag --> </searchTag>
            <searchTerm> <!- Search Term --> </searchTerm>
            <useTerm> <!- Use Term --> </useTerm>
            <isExplodable> <!- Term can be exploded (Y/N) --> </isExplodable>
         </rec>
      </records>
   </SearchResults>
</AuthoritySearchResponse>

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:AuthoritySearch xmlns:eit="http://epnet.com/webservices/SearchService/2007/07/">
      <eit:AuthoritySearchRequest>
        <eit:Query>[Search Query]</eit:Query>
        <eit:Authority_x0020_Database>[Authority Database to Search]</eit:Databases>
      </eit:AuthoritySearchRequest>
    </eit:AuthoritySearch>
  </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>
    <AuthoritySearchResponse xmlns="http://epnet.com/webservices/SearchService/2007/07/">
      <AuthoritySearchResponse>
        <Statistics>
          <!-- N-number of Statistic elements, one per database used during the search -->
          <Statistic>
            <Database>
              <!-- Database Short Name -->
            </Database>
            <Hits>
              <!-- Number of hits found for the query within the database -->
            </Hits>
          </Statistic>
        </Statistics>
        <SearchResults>
          <records>
            <!N-number of rec element, one per record returned from the search -->
            <rec recordID="xs:int">
              <!-- The exact structure will depend on a number of factors including the format used and authority searched -->
              <!-- Below is a list of more commonly used data items -->
              <browseTerm> <!-- Browse Term --> </browseTerm>
              <searchTag> <!-- Search Tag --> </searchTag>
              <searchTerm> <!- Search Term --> </searchTerm>
              <useTerm> <!- Use Term --> </useTerm>
              <isExplodable> <!- Term can be exploded (Y/N) --> </isExplodable>
            </rec>
          </records>
        </SearchResults>
      </AuthoritySearchResponse>
    </AuthoritySearchResponse>
  </soap:Body>
</soap:Envelope>