Search API documentation index

Documentation per API context

Replace /global with a catalogue id to search within a given library catalogue, e.g: /ol/tonsberg

Draft PLAS API implementation status

General notes:
Endpoint Status Endpoint notes
GetVersion 0.6.1
GetSearchConfiguration 0.6.1
  • Expression clustering is not included in response yet
GetWorks 0.6.1
SearchWorks 0.6.1
  • Note that the current implementation returns a representation of each work result that best matches the search query. Specifically, the titles and cover image are selected from the expression/manifestation that best matches the search query, within the constraints of some predefined preference rules. The most important one being that a physical book is preferred over an e-book or audiobook to represent the work. In practice, this implementation means that the two queries “Til fyret” and “To the lighthouse” will return the same work by Virginia Woolf, but represented with a Norwegian and English title and cover image, respectively. An alternative implementation could instead return a flat list of all titles and cover images and let the API client decide which to use, but the client would then have no hints on which title and cover image the user is most likely to recognize.
  • The PLAS sortings plas.titles.asc, plas.titles.desc are not implemented yet. This is indicated in the GetSearchConfiguration response.
GetPublications 0.6.1
GetAgents 0.6.1
SearchAgents 0.6.1
GetSuggestions Disabled