]> git.evergreen-ils.org Git - Evergreen.git/blob - docs-antora/modules/development/pages/data_opensearch.adoc
LP#1848524: AsciiDoc HEADING CONVERSION
[Evergreen.git] / docs-antora / modules / development / pages / data_opensearch.adoc
1 = Using Opensearch as a developer =
2
3 == Introduction ==
4
5 Evergreen responds to OpenSearch requests. This can be a good way to get
6 search results delivered in a format that you prefer.
7
8 Throughout this section, replace `<hostname>` with the domain or subdomain
9 of your Evergreen installation to try these examples on your own system.
10
11 Opensearch queries will be in the format
12 `http://<hostname>/opac/extras/opensearch/1.1/-/html-full?searchTerms=item_type(r)&searchClass=keyword&count=25`
13
14 In this example,
15
16 * html-full is the format you would like.  html-full is a good view for troubleshooting your query.
17 * searchTerms is a url-encoded search query.  You can use limiters in the `limiter(value)` format.
18 For example, you can use a query like `item_lang(spa)`
19 * count is the number of results per page.  The default is 10, and the maximum is 25.
20
21 Other options include:
22
23 * searchSort and searchSortDir, which can be used to display the results in a different order (e.g. for an RSS feed).
24