Parameters

Overview

Queries to the Search API are made up of the following query parameters:

  • s.bookMark - Bookmark search - Searches for a record matching a previously stored bookmark
  • s.cmd - Command - Allows commands to be passed to the Search API
  • s.debug - Debug - Enables or disables debug mode
  • s.dym - Did You Mean - Enables or disables did you mean functionality
  • s.exp - Query Expansion - Enables or disables query expansion functionality
  • s.fids - Fetch Multiple IDs - Allows retrieval of multiple records by querying on a list of IDs in a single call.
  • s.ff - Facet Field - Allows facet counts for a given field with a given combine mode
  • s.fvf - Facet Value Filter - Applies an exact-value filter for a facet value within a facetable field
  • s.fvgf - Facet Value Group Filter - Advanced feature that allows grouping of facet values within a facet-value filter, using an arbitrary combine mode
  • s.he - Highlight End - Sets the end delimiter for result highlighting
  • s.hs - Highlight Start - Sets the starting delimiter for result highlighting
  • s.hl - Highlight - Enables or disables highlighting within result fields
  • s.ho - Holdings Only - Enables or disables holdings only mode
  • s.l - Language - Defines the language that is used in the user interface application
  • s.light - Light Weight Response - Enables or disables the light weight response format
  • s.mr (deprecated - see s.rec.db.max) - Max Recommendations - Define the maximum number of database recommendations to be presented in the results
  • s.oaf - Open Access Filter - Filters the results by open access content only
  • s.pn - Page Number - Controls the offset of the returned results within the total result set
  • s.ps - Page Size - Controls the number of results per page in the response
  • s.rec.db.max - Max Recommendations - Define the maximum number of database recommendations to be presented in the results
  • s.rec.topic.max - Maximum Topics - Determines how many topics to be returned by the Topic Explorer service
  • s.role - Role - Define the user as an authenticated user or not. Two options are 'authenticated' and 'none'
  • s.rff - Range Facet Field - Allows facet counts by range
  • s.rf - Range Filter - Allows inclusive and exclusive range filters on a single field
  • s.ru - Content Rollup - Defines which content rollups to activate and how many records to be included in each rollup
  • s.sort - Sort - Controls the result sort order
  • s.fq - Text Filter - Filter input allowing direct Lucene-style filter queries
  • s.q - Text Query - One of the primary query inputs. The Text Query parameter allows direct, Lucene-style queries

Token Parameters

Parameters that do not conform to the syntax in the previous heading, such as author=Mark+Twain, will be picked up by the parser and used to token replace values in other parameters.

Example - How token parameters get used

Initial query string:

  author=Mark+Twain&s.q=Author:(${author})

Results in:

  s.q=Author:(Mark+Twain)

Try It


For more information on token replacing, see Tokens.


Character Escaping

Characters must be escaped with the backslash ('\') character. For all parameter values except s.q and s.fq, the characters that must be escaped include: ,:\()${}. For parameters and arguments that hold Lucene query syntax, characters that may need to be escaped include: +-&|!(){}[]^"~*?:\. Lucene special characters only need to be escaped if their special meaning was not intended. If Lucene escaping and regular escaping are both needed, as in the setTextQuery() command, the Lucene escaping must be performed before regular escaping.

All parameters must be properly URL-encoded using UTF-8 character encoding.

Example - An example query string

s.dym=true&
s.ff=ContentType%2Cor%2C1%2C1&
s.fvf=ContentType%2CJournal+Article%2Cfalse&
s.he=%3C%2Fh%3E&
s.hs=%3Ch%3E&
s.hl=true&
s.ho=true&
s.pn=1&
s.ps=10&
s.rff=PublicationDate%2C1990%3A2000&
s.rf=PublicationDate%2C1990%3A2000&
s.sort=PublicationDate%3Adesc&
s.fq=Title%3Arain&
s.q=forests

Try It