EBSCOhost

EBSCOhost Integration Toolkit

SearchService

Click here for a complete list of operations.

AuthoritySearch

The AuthoritySearch method is used to perform authority searches on EBSCOhost reference system.

To test the operation using the HTTP GET protocol, click the 'Invoke' button.

Parameter Value Default Value Notes
prof:(customerID.groupID.profileID)
  • Required Field if using Profile Authentication
pwd:
  • Required Field if using Profile Authentication
authType: profile
  • Indicates if using IP Authentication or Profile Authentication. Valid values are: (ip, profile)
ipprof:(profileID)
  • Required Field if using IP Authentication
query:
  • term to be searched on.
  • Required Field
startrec: 1
  • Starting record number for the result set returned from a search.
  • Greater than 0
numrec: 10
  • Number of records returned from a search (if available).
  • Between 1 and 200
mode: relevancy
  • The authority search mode.
  • Valid values are: (relevancy, alphabetic, boolean, termcontains)
db:
  • One short authority database name to search.
  • Required Field
format: list
  • The format of the results' records.
  • Valid values are: (list, detailed, tree)
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.

The following is a sample HTTP GET response. 

<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>