Brief Search

The query parameter is a combination of three parameters that are separated by a comma:
&query=<field>,<precision>,<value>

1) field – The field to search against
2) precision – A precision operator (i.e exact/contains/begins_with)
3) value – Any value
Examples:

&query=facet_topic,exact,Nonfiction
&query=any,contains,queens+of+the+stone+age (the value contains more than one term in it)

Note: The query parameter can be used more than once in the URL thus causing for an AND correlation between the two values:

For example:
&query=creator,contains,comm&query=facet_creator,exact,United+States

1) <field> possible values:
The field names to be used are field names used by the search engine. As such their names are a bit different than what you would expect. The below will list the relevant field names:
a) any –
Will search against most of the fields at once.
Example: &query=any,contains,queens
b) regular fields –
(taken from the code table: “Basic Index Fields”):
desc, title, creator, sub (subject), rtype (resource type), isbn, issn,
rectype (record type), dlink (down link), ftext (full text), general, toc, fmt,
lang, cdate (creation date), sid (source ID), rid (record ID),
addsrcrid (additional source ID), addtitle, pnxtype, alttitle,
abstract, and fiction
Example: &query=rid,exact,PRIMO1234
b) facet fields –
(taken from the code table: “Facets Code Fields”):
facet_creator, facet_lang, facet_rtype, facet_pfilter, facet_topic,
facet_creationdate, facet_dcc, facet_lcc, facet_rvk,
facet_tlevel,facet_domain, facet_fsize, facet_fmt, facet_frbrgroupid,
facet_frbrtype, facet_local1 – facet_local50
Example: &query=facet_creator,exact,william+s+burroughs

2) <precision>possible values:

NOTE: for facets, the only possible precision value is exact (i.e. &query=facet_topic,exact,Nonfiction)

a) exact – When searching for a phrase (more than one term,
i.e “queens of the stone age”) and we want an exact match
for this phrase.
                 Note: When querying for one term there is no difference
between exact and contains
Example: &query=title,exact,queens+of+the+stone+age
b) contains -When searching for one term, will return results for any field
containing this term. When searching for a phrase, will return
results for any field containing at least one of the given terms.
For example:
                      &query=title,contains,queens+of+the+stone+age

will return titles like:
“the age of life”, “kings and queens” or
“age and health of queens”

c) begins_with – Works only against the sort title field (swstitle)!
The swstitle was not mentioned above. The swstitle is the
title under the sort section in the PNX.
Note: 1) When using this precision, there is no meaning to
                                            the field you are using, as it will always search
                                            against the swstitle field!
2) Usually you will want to use sortField=stitle, when searching with begins_with (and not the default relevance)

3) <value> possible values:
Any value is allowed.
Values including commas in them should replace the comma with a space. For example, if you want to use “A,B,C” as the value, specify the following query:

The value can also hold multiple values with an OR, AND, or NOT operator:

This will result in a query similar to the following:  title contains Queen OR title contains Stone

Note: The AND, OR, and NOT operators cannot be used between query parameters.

Supported from version V4.0 only.
Query a facet including multiple values:

&query_inc=<field>,<precision>,<value1, value2,…>

Example: &query_inc=facet_topic,exact,women,science

field – any facet fields –
(taken from the code table: “Facets Code Fields”):
facet_creator, facet_lang, facet_rtype, facet_pfilter, facet_topic,
facet_creationdate, facet_dcc, facet_lcc, facet_rvk,
facet_tlevel,facet_domain, facet_fsize, facet_fmt, facet_frbrgroupid,
facet_frbrtype, facet_local1 – facet_local50

precision – The precision operator MUST only hold the “exact” value (other values are not supported).

value1, value2.. – any value or multiple values separated by a comma. (Values including commas in them should replace the comma with a space)

The query created will generate an OR query between the values:
i.e. (facet_topic=value1 OR facet_topic=value2 OR …)

You can use the query_inc multiple times in the query:
i.e. &query_inc=facet_topic,exact,women,science&query_inc=facet_lang,exact,eng,heb

Supported from version V4.0 only.
Query a facet excluding multiple values:

&query_exc=<field>,<precision>,<value1, value2,…>

Example: &query_exc=facet_topic,exact,women,science

field – any facet fields –
(taken from the code table: “Facets Code Fields”):
facet_creator, facet_lang, facet_rtype, facet_pfilter, facet_topic,
facet_creationdate, facet_dcc, facet_lcc, facet_rvk,
facet_tlevel,facet_domain, facet_fsize, facet_fmt, facet_frbrgroupid,
facet_frbrtype, facet_local1 – facet_local50

precision – The precision operator MUST only hold the “exact” value (other values are not supported).

value1, value2.. – any value or multiple values separated by a comma. (Values including commas in them should replace the comma with a space)

The query created will generate an AND query between the values:
i.e. (facet_topic=value1 AND facet_topic=value2 AND …)

You can use the query_exc multiple times in the query:
i.e. &query_exc=facet_topic,exact,women,science&query_exc=facet_lang,exact,eng,heb

highlight
Indication whether highlights by server is required.
Possible values: true or false
Default: false

If highlight=true, you must supply one or more  displayField parameters to indicate which fields to highlight.

displayField
defines in which field from the Display section of the PNX to highlight, if it contains the search term.
Possible values: PNX field names from the Display section.
You can define more than 1 displayField:
&highlight=true&displayField=title&displayField=creator

Note: the highlighting is done by wrapping the relevant section in the PNX with a <span> tag,
i.e. <span class=”searchword”>BOOK</span>

Possible values: true or false
Default: false

“eng” or “fre” or “ger” (Code for the representation of name of language conform to ISO-639)

• stitle – performs Title sort.
• scdate – performs a date sort in descending order.
• scdate2 – performs a date sort in ascending order.
• screator – performs an author sort.
• popularity – performs a popularity sort.

The valid values for this parameter are defined with the Index Field column in the Sort Fields Config mapping table, as shown below. The direction of the sort is defined with the Direction column.

http ://il-primo03:1702/PrimoWebServices/xservice/search/brief?institution=PRIMO&query=any,contains,book&indx=20&bulkSize=10&loc=local,scope:(VOLCANO)
Example for multi search (two)  targets:

http ://il-primo03:1702/PrimoWebServices/xservice/search/brief?institution=PRIMO&query=any,contains,book&indx=20&bulkSize=10&loc=local,scope:(VOLCANO)&loc=adaptor,primo_central_multiple_fe

Example for multi search (three)  targets:

http ://il-primo03:1702/PrimoWebServices/xservice/search/brief?institution=PRIMO&query=any,contains,book&indx=20&bulkSize=10&loc=local,scope:(VOLCANO)&loc=adaptor,primo_central_multiple_fe&loc=remote,Business and Sciences

Multiple scopes
You can search multiple scopes in 2 ways:
1) loc=local,scope:(VOLCANO,NORTH)
2) Use multiple loc parameters:
&loc=local,scope:(VOLCANO)&loc=local,scope:(NORTH)
There is a limitation to the order and which scopes can be used in such queries.
The limitation is according to the “Search Scopes” you have defined for each view.
To be sure what your “Search scopes” are, you can view the following file on your FE machine:
$primo_dev/ng/jaguar/home/system/conf/search_schema.xml

under the <filters> tag you will find all your configured search scopes:
<filters>
<filter>facet_frbrtype:(7 OR 6)</filter>
<filter>NOT scope:(“PRIMO”)</filter>
<filter>scope:(NORTH)  OR scope:(demo_digitool) OR scope:(“CENTRAL”)</filter>
<filter>scope:(BBR)</filter>
You are allowed to use only those scopes listed in the file and only use the order as in the file.
Mixing the order will not work, so &loc=local,scope:(NORTH, demo_digitool, “CENTRAL”) will work but &loc=local,scope:( demo_digitool, NORTH,”CENTRAL”) will not!
Searching against Primo Central
Searching against Primo Central is done via an adaptor.
Therefor as mentioned above, you will need to add the following:
loc=adaptor,primo_central_multiple_fe

Possible values: agriculture_forestry, anthropology, arts_humanities, biology, business,
chemistry, computer_science, earth_sciences, economics, education, engineering,
geography, languages_literature, law, library_information_science, mathematics, medicine,
nursing, pharmacy_therapeutics_ pharmacology, philosophy_religion, physics,
political_sciences, psychology, public_health, sciences, social_sciences, sociology,
veterinary_medicine
Example: &pyrCategories=chemistry;business

Possible values: graduate, librarystaff, researcher, undergraduate
Example: &pyrDegree=undergraduate

&query=dr_s,exact,YYYYMMDD&query=dr_e,exact,YYYYMMDD

i.e. &query=dr_s,exact,19840201&query=dr_e,exact,99991231