]> git.evergreen-ils.org Git - Evergreen.git/blob - docs-antora/modules/opac/pages/search_url.adoc
LP#1848524: Docs: section fixes
[Evergreen.git] / docs-antora / modules / opac / pages / search_url.adoc
1 == Search URL ==
2
3 indexterm:[search, URL]
4
5 When performing a search or clicking on the details links, Evergreen constructs 
6 a GET request url with the parameters of the search. The url for searches and 
7 details in Evergreen are persistent links in that they can be saved, shared and 
8 used later.
9
10 Here is a basic search URL structure:
11
12
13 +++[hostname]+++/eg/opac/results?query=[search term]&**qtype**=keyword&fi%3Aitem_type=&**locg**=[location id]
14
15 === locg Parameter ===
16 This is the id of the search location. It is an integer and matches the id of the
17 location the user selected in the location drop down menu.
18
19 === qtype Parameter ===
20
21 The _qtype_ parameter in the URL represents the search type values and represent
22 one of the following search or request types:
23
24 * Keyword 
25 * Title
26 * Journal Title
27 * Author
28 * Subject
29 * Series
30 * Bib Call Number
31
32 These match the options in the search type drop-down box.
33
34 === Sorting ===
35
36 The _sort_ parameter sorts the results on one of these criteria.
37
38 * `sort=pubdate` (publication date) - chronological order
39 * `sort=titlesort` - Alphabetical order
40 * `sort=authorsort` - Alphabetical order on family name first
41
42 To change the sort direction of the results, the _sort_ parameter value has the
43 ".descending" suffix added to it.
44
45 * `sort=titlesort.descending`
46 * `sort=authorsort.descending`
47 * `sort=pubdate.descending`
48
49 In the absence of the _sort_ parameter, the search results default to sorting by
50 relevance.
51