Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

QueryThe parsed query that was submitted to the server.
FilterQueriesA comma separated list of any filters that are in use on the query.
SearchTimeThe number of milliseconds it took to run the search on the server.
TotalCountThe total number of results for the query.
PageThe pagination offset for the list of results.
PageSizeThe number of results to display during pagination.
MatchingTermsA list of matching terms.
FilterFieldsA list of filter fields.
ResultsThe list of results.

Anchor
matchingterm
matchingterm
MatchingTerm Element

...

Returns a list of search results and faceting details for a query on names.

Parameters

skip
query

Search string using the Search Query Syntax

 

query=lic*
filter

Additional filter to provide faceting of the results

Available Filter Fields

  • rank
  • governingcode
  • status
  • class
  • providercode
  • kingdom
filter=rank:genus
pageNumber of records to skip when returning the resultspage=1
takepagesizeThe number of records to returnpagesize=5
orderby

Enables sorting of the results using the syntax:

fieldname [ASC|DESC]

orderby=rank DESC,fullname

Example Response

http://data.nzor.org.nz/names/search?query=lic*

...