Page tree

GET /catalogues

Description: Search for Catalogue records

ParameterExampleNotes

search

REQUIRED

search=lawSearch condition to search records. See Using the search parameter for detailed use/examples of this parameter

search-id

OFTEN REQUIRED

search-id=120Every unique search produces a searchID.  The search-id should be passed each time a user is requesting data from the database using the same query as previously done. So for example if you are requesting page 2 of results from your earlier search by passing the SearchID generated from that first search it will speed up the response of the results for page 2. If the search parameters change in any way the SearchID should not be passed and a new one will be created.
search-insearch-in=405SearchID taken from original search can be used to filter that search further by specifying the ID and new search parameter. i.e search-in=405&search=Title:Joint will take the original search query from ID 405 and filter to only include records where joint appears in the title field.
include-dependentinclude-dependent=1

Option to include or exclude dependent records in search result. 

Possible values:

1= Include dependant records

0= Don't include dependant records (default if not set)

save-historysave-history=0

Option to set whether search need to be saved in the user search history for future reference.

Possible values:

1= Save search detail to database for reporting purposes 

0= Don't save search detail (default if not set)

This option can be enforced from system configuration maintenance > API > Save search history meaning the parameter does not need to be set and all searches will be logged automatically.

without-copieswithout-copies=1

Option to set whether records without copies can be included in search result or not. 

Possible values:

1= Include records without copies  (default if not set)

0= exclude records without copies

deleteddeleted=0

Option to set whether deleted records can be returned in search result or not.

Possible values:

NonDeleted = 0, (default if not set)
        Deleted = 1,
        Both = 2
pub-statuspub-status=1

Option to set whether records without published flag set can be returned in the search result or not. By default returns only published records.

Possible values:

2= Published and unpublished  

1= Published only  (default if not set)

0= unpublished only 

include-attachmentsinclude-attachments=1

Option to set whether attachment records need to be returned in the search result or not.

Possible values:

1= search within indexed documents  (default if not set)

0= exclude indexed documents  

include-issueinclude-issue=1

The option to set whether issue records need to be included in the search result or not.

Default is to include issue records

read-content-typeread-content-type=Printed MaterialContent type identifier or caption to read records from.
content-record-type

content-record-type=Printed Material:Books

content-record-type=14:2;1:18 - Returns content type 14 & record Type 2 and also records from content type 1 and RT 18.

content-record-type=14: - returns all records from content type 14

content-record-type=:1 - returns all records from record type 1

content-record-type=14;1  - returns all records from content types 14 and 1

content-record-type=:2;:18 - returns all records from record types 2 and 18


Content/record type pairs to filter search result, use name or ID. Use ; to add multiple CT/RT pairs. If Requesting only CT there is no need to specify : after the CT. But if requesting multiple RT you must include : between each RT.


sorting


  • sorting=Title:Ascending
  • sorting=Title:0:WithNoiseWords
  • sort=Title:Ascending:WithNoiseWords;Publication Date:Descending;24:Ascending

By default the search result template sorting rules applied. Sort field can be by name or ID.

Sort direction uses Ascending (0) or Descending (1) when added after field name. Ascending is the default.

To sort without noise words (a,the..) being used add :WithNoiseWords (0) after sort direction. Or  :WithoutNoiseWords (1) to include noise words in the sort order. WithNoiseWords is the default.

Sorting by multiple fields can be done separating each sort using semi-colon ( ; ).

result-viewresult-view

Search result view name to use to get list of fields to be returned. Citation (or 1), Thumbnail (or 2), GridView (or 3)

Highest priority is an exact match for Portal, app mode (definition is if user is a guest, logged in user or administrator) and content type, if not all three are matched then the below priority order is used.

  1. Match by app mode, portal. Content Type = NULL
  2. Match by app mode, portal = NULL, Content Type match
  3. Match by app mode, portal = null, ct = null
  4. App mode = null, portal match, CT match
  5. App mode = null, portal match, CT = null
  6. app mode = null, portal null, CT match
  7. app mode = null, portal null, CT = null

Result Groups are not included in API result-view, it is expected that these can be generated manually via the API if required.

pagepage=2Search result page number to return records from. The page number start from 1. 
page-sizepage-size=100Amount of records to return per each page.
langlang=2057Language name or LCID code to use to search records and return language dependent data in the data records.
read-fieldsread-fields=Title,11,Authors

Comma separated list of fields to return in the search result. The field can be it's caption or unique identifier.

It is also possible to return all fields for a query within the search request using &read-fields={allFields} However this should be used sparingly and only when it is necessary to crawl the API results for updates, i.e if you are using it to populate a third party DB with content. Soutron request you only perform such crawls when required and outside of normal working hours to minimise impact on servers and performance.

officeoffice=1Office name or ID to use for search data (affects search permission)
portalportal=1Portal name or ID to use for search data (affects search permission)
name-standardname-standard=risField captions naming standard to use
xmlTypexmlType=1The way of XML response format. Supported values are AttributeBase (0) or ElementBase (1). The default is attribute based.

Request: /SoutronAPI/catalogues/?search=Title:management&sort=Title:Ascending&content-record-type=1;4&read-record-type=4&read-fields=Title,11,Authors&page-size=1&page=8

Response
<response searchTime="556" sortTime="87" requestTime="816.2079">
	<resultInfo portalView="https://devtesting.soutron.net/Portal/Default/en-GB/Search/AdvancedSearch/?searchResultId=909" searchId="909">
		<contentTypes>
			<contentType caption="All" count="645" seq="0" current="1"/>
			<contentType id="1" caption="Printed Material" count="597" seq="1"/>
			<contentType id="4" caption="Electronic (Library)" count="48" seq="2"/>
		</contentTypes>
		<recordTypes>
			<recordType id="1" caption="Books" count="548"/>
			<recordType id="3" caption="Web Item" count="16"/>
			<recordType id="16" caption="Video" count="2"/>
			<recordType id="17" caption="Electronic" count="30"/>
			<recordType id="18" caption="Book (Chapter)" count="47"/>
			<recordType id="19" caption="Non-Stock" count="2"/>
		</recordTypes>
	</resultInfo>
	<records>
		<record id="357022" type="10" subType="1" rt="1" rtCaption="Books" ct="1" ctCaption="Printed Material" deleted="0" published="1">
			<fs>
				<f id="9" type="1" caption="Title">
					<vs>
						<v id="2002309" seq="1" custom="0">A guide to fire safety management</v>
					</vs>
				</f>
				<f id="14" type="5" caption="Authors">
					<vs>
						<v id="2152149" seq="1" custom="1" value="55369">Dailey, William</v>
					</vs>
				</f>
			</fs>
		</record>
	</records>
</response>





  • No labels