...
| Query | The parsed query that was submitted to the server. |
|---|---|
| FilterQueries | A comma separated list of any filters that are in use on the query. |
| SearchTime | The number of milliseconds it took to run the search on the server. |
| TotalCount | The total number of results for the query. |
| Page | The pagination offset for the list of results. |
| PageSize | The number of results to display during pagination. |
| MatchingTerms | A list of matching terms. |
| FilterFields | A list of filter fields. |
| Results | The list of results. |
| Anchor | ||||
|---|---|---|---|---|
|
The MatchingTerm elements are returned from prefix or fuzzy match type queries and represent other possible searches that are similar to the current search request.
| FieldName | The name of the field that can be supplied to a new query. |
|---|---|
| Text | Text that is similar to the current query. |
| HitCount | The number of terms that matched the text. |
| Anchor | ||||
|---|---|---|---|---|
|
FilterField elements represent terms and fields that can be used to facet or refine the current search.
| FieldName | The name of the field that can be used to refine the search. |
|---|---|
| DisplayName | The display name of the field for use on a user interface. |
| FilterTerms | A list of filter terms. |
| Anchor | ||||
|---|---|---|---|---|
|
Actual search result.
| Score | |
|---|---|
| NameId | |
| NameClassName | |
GoverningCode | |
| FullName | |
| PartialName |
...
| query | Search string using the Search Query Syntax |
| filter | Additional filter to provide faceting of the results |
| skip | Number of records to skip when returning the results |
| take | The number of records to return |
| orderby | Enables sorting of the results using the syntax: fieldname [ASC|DESC] |
...
Example Response
http://data.nzor.org.nz/names/search?query=lic*
...