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