Skip to content

Routes

/institutions/<institution_id:str>

Retrieves a specific institution record, identified by institution_id.

For example, /institutions/30000004

/institutions/<institution_id:str>/sources

Query the sources attached to this institution. Supports all search options for sources.

/people/<person_id:str>

Retrieves a specific person record, identified by person_id.

For example, /people/20000365.

/people/<person_id:str>/sources

Query the sources attached to this person. Supports all search options for sources.

/probe

A probe request will return the number of results should a search be performed, so it has all the functionality of the /search handler. The difference is that it will not return any actual results. Instead, it will return the total number of results, and any facets or modes that would be active for a given search query.

For querying, the following query parameters are recognized:

  • q: The main query parameter. Required, Non-repeatable! ":" if not explicitly passed in.
  • nc: The requested national collection filter. This applies to anything that is limited nationally, such as sources and institutions. When a nc filter is applied, things not limited nationally, such as people, are omitted from the response.
  • fq: The main filter queries. Repeatable. Takes parameters like "name:Smith, John" and uses them as facet queries.
  • fb: The filter behaviours. Repeatable. Adjusts the named filter behaviour from 'intersection' and 'union'. For example, if we have fq=composer:Smith, John&fq=composer:Smythe, Jane, then &fb=composer:union would change the behaviour of the composer facet. Acceptable values are intersection (default) and union.
  • mode: Sets the mode of the search to return records of only that type.
  • page: Controls the return of the result page. Pages can be of multiple size, but this should always skip to the correct page.
  • rows: Number of results per page.
  • sort: Controls the sorting of returned results

Some parameters are specific to only incipit searches:

  • n: A Plaine and Easie string containing an encoded incipit search.
  • im: Incipit search mode. Controls the type of mode used for matching incipits. Supports a value of 'intervals' (default) and "exact-pitches".
  • ic: Controls the rendering of the incipit clef.
  • it: Controls the rendering of the incipit time signature.
  • ik: Controls the incipit key signature. The value of this will also change interval values, so it may have an impact on the results.

/sources/<source_id:str>

Retrieves a specific source, identified by the source_id.

For example, /source/990041209.

/sources/<source_id:str>/contents

Performs a search query for searches against the items in this source. All queries valid for general source searches are valid as query arguments for this endpoint, except that the mode cannot be changed from sources.

/suggest

A suggest request will return a list of suggested terms based on a partial query for configured fields. The supported query parameters are:

  • alias: The field name to search for term suggestions
  • q: The query term for which a suggestion is to be made