Page tree

Text & all field searching

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.

ExampleSyntaxNotes
To search in any field for the word risk in any fieldSoutronAPI/catalogues?search=risk
To search for the phrase risk management 2019 in any fieldSoutronAPI/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 replacementSoutronAPI/catalogues?search=Title:organi*ationWill 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.

ExampleSyntaxNotes
To search for the word management in the Title fieldSoutronAPI/catalogues/?search=Title:management 
To search for the word management in the Title field using the field IDSoutronAPI/catalogues/?search=9:management 
To search for the word smith in the Authors fieldSoutronAPI/catalogues?search=Authors:smith
To search for a value of 185431887X in the ISBN fieldSoutronAPI/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.

ExampleSyntaxNotes
To search for the word regulation in the Title field groupSoutronAPI/catalogues?search=grTitles:regulation
To search for the word regulation in the Title field group using the field IDSoutronAPI/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 ( + )

ExampleSyntaxNotes
Search for two ISBN's using AND BooleanSoutronAPI/catalogues?search=ISBN:185431887X;+ISBN:9781587783647ISBN 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 BooleanSoutronAPI/catalogues?search=Title:management;+Title:riskBoth management and risk must exist for the record to be returned.

OR ( | )

ExampleSyntaxNotes
Search for two ISBN's using OR BooleanSoutronAPI/catalogues?search=ISBN:185431887X;|ISBN:9781587783647ISBN 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 BooleanSoutronAPI/catalogues?search=Title:management;|Title:riskBoth management and risk must exist for the record to be returned.

NOT ( - )

ExampleSyntaxNotes
Search for two ISBN's using NOT BooleanSoutronAPI/catalogues?search=ISBN:185431887X;-ISBN:9781587783647Records containing ISBN 185431887X but NOT 9781587783647 will be returned.
Search for two words in the title field using NOT BooleanSoutronAPI/catalogues?search=Title:management;-Title:riskRecords 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 )

ExampleSyntaxNotes
Search for records which has a volume quantity of 14 OR 6SoutronAPI/catalogues?search=Volume quantity:[14,|6]
Search for records which has a volume quantity between 6 AND 14SoutronAPI/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 BooleanSoutronAPI/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] )

ExampleSyntaxNotes
Search for records which has a format of DVDSoutronAPI/catalogues?search=Format:DVD
Search for records which has a format of CD or DVDSoutronAPI/catalogues?search=Format:[6,|DVD]

Empty/Populated field searching

To return only records which have or do not have a value i a specific field use {hasValue} or {noValue}.

ExampleSyntaxNotes
Get all records which has a value in the Author fieldSoutronAPI/catalogues?search=Authors:{hasValue}
Get all records which does not have a value in the Author fieldSoutronAPI/catalogues?search=Authors:{noValue}

Thesaurus Searching

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 value attribute within the <v> element (68584).


Example
<f id="37" type="5" caption="Subjects">
	<vs>
		<v id="2292430" seq="1" custom="1" value="68584">Reinsurance</v>
	</vs>
</f>
ExampleSyntaxNotes
Search the subjects thesaurus field for the term ReinsuranceSoutronAPI/catalogues?search=Subjects:Reinsurance
Search the subjects thesaurus field for the term Reinsurance using its ID 68584SoutronAPI/catalogues?search=Subjects:68584

Date Searching

Date searching is similar to number searching as it supports range <> and array [] using ISO date format (YYYY-MM-DD).


ExampleSyntaxNotes
Search for all records created in the a period (2 month) SoutronAPI/catalogues?search=Created Date:2-month

Period can be specified as the caption or integer.

Possible periods:

day (0)

week (1)

month (2)

year (3)

quarter (4)




Search for all records created in the last 10 days OR last 45 monthsSoutronAPI/catalogues?search=Created Date:[10-day,|45-month]Search by multiple dates, both are periods search type
Search Created Date by single exact date and timeSoutronAPI/catalogues?search=Created Date:2020-03-31 18:43:25
Search Created Date by single exact datesearch=Created Date:2020-03-25
Search Created Date by month (March) and Year (1995) OR by Year (1990) SoutronAPI/catalogues?search=Created Date:[1995-03-,|1990--]Year only, year+month, year+month+day are the only supported combinations currently.
Search Created Date using a range (2020-03-21<>2020-03-24 ) OR by exact date (2020-03-25)search=Created Date:[2020-03-21<>2020-03-24,|2020-03-25]Use Range searching using <> 

Incremental Searching

ExampleSyntaxNotes

Search the Incremental field for the exact value of 1997/000216 

/SoutronAPI/catalogues?search=Incremental:"1997/000216"



  • No labels