---
title: "Using the search parameter"
canonical: "https://support.soutron.net/space/LMSAPI/2228323/Using%20the%20search%20parameter"
format: markdown
---
## Text & all field searching

<span style="color: #000000">To search without being specific about the field to search enter your search word phrase after the search parameter. As well as single word or phrase searching it is also possible to use truncation at the end or within a word.</span>

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| To search in any field for the word **risk in any field** | SoutronAPI/catalogues?search=risk |  |
| To search for the phrase **risk management 2019** in any field | SoutronAPI/catalogues?search='risk management 2019' | Encode your search phrase in single quotes. |
| To search for all words starting with 'manage' | SoutronAPI/catalogues?search=Manag! | Eill return records containing manager, managing, management |
| To search for a word with wildcard letter replacement | SoutronAPI/catalogues?search=Title:organi*ation | Will find records with the same word spelt in different ways i.e will find **organisation** or **organization** |

## Field specific searching

To search in a specific field include the field name or ID before your search value.

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| To search for the word **management** in the **Title** field | SoutronAPI/catalogues/?search=Title:management<span style="color: #172b4d"> </span> |  |
| To search for the word **management** in the **Title** field using the field ID | SoutronAPI/catalogues/?search=9:management<span style="color: #172b4d"> </span> |  |
| To search for the word **smith** in the **Authors** field | SoutronAPI/catalogues?search=Authors:smith |  |
| To search for a value of **185431887X **in the **ISBN** field | SoutronAPI/catalogues?search=ISBN:185431887X |  |

## Field group searching

To search in a field group include the group name or group ID prefixed with **gr** before your search value.

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| To search for the word **regulation** in the **Title** field group | SoutronAPI/catalogues?search=grTitles:regulation |  |
| To search for the word **regulation **in the **Title** field group using the field ID | SoutronAPI/catalogues?search=gr1:regulation |  |

## Boolean searching

Each value should be separated by semi-colon and the Boolean symbol. Include the field name for each value you are searching. If a boolean is not supplied AND is used by default.

#### AND ( + )

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Search for two **ISBN's** using **AND **Boolean | SoutronAPI/catalogues?search=ISBN:185431887X;+ISBN:9781587783647 | ISBN **185431887X** and **9781587783647** must both exist in the same record for it to be returned. |
| Search for two words in the **title** field using **AND **Boolean | SoutronAPI/catalogues?search=Title:management;+Title:risk | Both **management** and **risk** must exist for the record to be returned. |

#### OR ( | )

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Search for two **ISBN's** using **OR** Boolean | SoutronAPI/catalogues?search=ISBN:185431887X;|ISBN:9781587783647 | ISBN **185431887X** OR **9781587783647** should exist in the same record for it to be returned, if both exist in different records both will be returned. |
| Search for two words in the **title** field using **OR **Boolean | SoutronAPI/catalogues?search=Title:management;|Title:risk | Both **management** and **risk** must exist for the record to be returned. |

#### NOT ( - )

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Search for two **ISBN's** using **NOT **Boolean | SoutronAPI/catalogues?search=ISBN:185431887X;-ISBN:9781587783647 | Records containing ISBN **185431887X** but NOT **9781587783647** will be returned. |
| Search for two words in the **title** field using **NOT **Boolean | SoutronAPI/catalogues?search=Title:management;-Title:risk | Records containing **management** in the title field will be returned only if **risk** does **NOT** exist in the same title phrase**.** |

## Number searching

Number searching can be done by individual number,  using an array or by range. Boolean is also supported, default if not specified is **AND**.

[ ] means array where each item separated by comma (i.e. [6,7,8] )

<> means range with lowest value to the left highest to the right. (i.e. 10<>20 )

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Search for records which has a **volume quantity** of **14** **OR 6** | SoutronAPI/catalogues?search=Volume quantity:[14,|6] |  |
| Search for records which has a **volume quantity** **between 6 AND 14** | SoutronAPI/catalogues?search=Volume Quantity:[6<>14] | This will find all records which have a quantity between 6 and 14 Inclusive. Use <> symbols to define the range. |
| Search for records which exist in either **range** using **OR** Boolean | SoutronAPI/catalogues?search=Volume%20quantity:[1<>8,|10<>20] | This will find records which fall within the 1<>8 range OR the 10<>20 range. |

## Validation list searching

Validation list searching can be done by ID or description,  using an array or by range. Boolean is also supported, default if not specified is **AND**.

[ ] means array where each item separated by comma (i.e. [6,7,8] )

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Search for records which has a **format** of** DVD** | SoutronAPI/catalogues?search=Format:DVD |  |
| Search for records which has a **format** of **CD or DVD** | SoutronAPI/catalogues?search=Format:[6,|DVD] |  |

## Empty/Populated field searching

<span style="color: #000000">To return only records which have or do not have a value i a specific field use {hasValue} or {noValue}.</span>

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Get all records which **has** a value in the **Author** field | SoutronAPI/catalogues?search=Authors:{hasValue} |  |
| Get all records which **does not have **a value in the **Author** field | SoutronAPI/catalogues?search=Authors:{noValue} |  |

## Thesaurus Searching

<span style="color: #000000">Searching in a thesaurus field can be done by the term text or termID. Searching by text works in the same way as text searching. Searching by Term ID also supports similar methods as text searching such as Boolean but you will need to first identify the termid, this can be found in the XML as below for the term Reinsurance using the value of the </span>**<span style="color: #000000">value </span>**<span style="color: #000000">attribute within the </span>**<span style="color: #000000"><v></span>**<span style="color: #000000"> element (</span>**<span style="color: #000000">68584</span>**<span style="color: #000000">).</span>


When searching and including parameters for a thesaurus term search the parameters should be enclosed within {} and separated with a comma. i.e. SoutronAPI/catalogues?search=Authors:<span style="color: #ff0000">{</span>termid:239825<span style="color: #ff0000">,</span>traverseTerms:1<span style="color: #ff0000">,</span>inclRelTerms:0<span style="color: #ff0000">}</span>

<span style="color: #000000">You can also use the termID or text to search such as:</span>**<span style="color: #000000"> termid:239825</span>**<span style="color: #000000"> or </span>**<span style="color: #000000">text:Craig Parsons</span>**

<details>
<summary>Example</summary>

```xml
<f id="37" type="5" caption="Subjects">
	<vs>
		<v id="2292430" seq="1" custom="1" value="68584">Reinsurance</v>
	</vs>
</f>
```
</details>

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Search the **subjects** thesaurus field for the term **Reinsurance** | SoutronAPI/catalogues?search=Subjects:Reinsurance |  |
| Search the **subjects** thesaurus field for the term **Reinsurance** using its ID **68584** | SoutronAPI/catalogues?search=Subjects:68584 |  |
| Search the **author** thesaurus and include records with **related** terms in the search results | SoutronAPI/catalogues?search=Authors:{text:Craig Parsons,inclRelTerms:1}<br>SoutronAPI/catalogues?search=Authors:{termid:239825,inclRelTerms:0} | 1= Include related<br>0= do not include related |
| Search the **author** thesaurus and include records with **narrower **terms in the search results | SoutronAPI/catalogues?search=Authors:{text:Craig Parsons,traverseTerms:1}<br>SoutronAPI/catalogues?search=Authors:{termid:239825,traverseTerms:1} | 1= Include related<br>0= do not include related |


## Date Searching

<span style="color: #000000">Date searching is similar to number searching as it supports range <> and array [] using ISO date format (YYYY-MM-DD).</span>


| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Search for all records **created** in the a **period** (2 month) | SoutronAPI/catalogues?<span style="color: #003366">search=Created Date:2-month</span> | <span style="color: #003366">Period can be specified as the caption or integer.</span><br><span style="color: #003366">Possible periods: </span><br><span style="color: #003366">day (0)</span><br><span style="color: #003366">week (1)</span><br><span style="color: #003366">month (2)</span><br><span style="color: #003366">year (3)</span><br><span style="color: #003366">quarter (4)</span> |
|  |  |  |
| Search for all records created in the last **10 days** **OR **last **45 months** | SoutronAPI/catalogues?<span style="color: #003366">search=Created Date:[10-day,|45-month]</span> | <span style="color: #003366">Search by multiple dates, both are periods search type</span> |
| <span style="color: #003366">Search </span>**<span style="color: #003366">Created Date</span>**<span style="color: #003366"> by single exact </span>**<span style="color: #003366">date</span>**<span style="color: #003366"> and </span>**<span style="color: #003366">time</span>** | <span style="color: #003366">SoutronAPI/catalogues?search=Created Date:2020-03-31 18:43:25</span> |  |
| <span style="color: #003366">Search </span>**<span style="color: #003366">Created Date</span>**<span style="color: #003366"> by single exact </span>**<span style="color: #003366">date</span>** | <span style="color: #003366">search=Created Date:2020-03-25</span> |  |
| Search **<span style="color: #003366">Created Date</span>**<span style="color: #003366"> by </span>**month** (March) and **Year** (1995) OR by **Year** (1990) | <span style="color: #003366">SoutronAPI/catalogues?search=Created Date:[1995-03-,|1990--]</span> | <span style="color: #003366">Year only, year+month, year+month+day are the only supported combinations currently.</span> |
| <span style="color: #003366">Search </span>**<span style="color: #003366">Created Date</span>**<span style="color: #003366"> using a </span>**<span style="color: #003366">range</span>**<span style="color: #003366"> (2020-03-21<>2020-03-24 ) </span>**<span style="color: #003366">OR</span>**<span style="color: #003366"> by </span>**<span style="color: #003366">exact date </span>**<span style="color: #003366">(2020-03-25)</span> | <span style="color: #003366">search=Created Date:[2020-03-21<>2020-03-24,|2020-03-25]</span> | Use Range searching using <> |

## Incremental Searching

| **Example** | **Syntax** | **Notes** |
| --- | --- | --- |
| Search the **Incremental **field for the exact value of **1997/000216** | [/SoutronAPI/catalogues?search=Incremental:"1997/000216](https://devtesting.soutron.net/SoutronAPI/catalogues?search=Incremental:%271997/000216%27)" |  |