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