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