Services and Operations > Standard service > searchCatalog

searchCatalog

The searchCatalog operation allows you to execute a keyword search of the library catalog.

Synopsis

Service

Standard service

Namespace

http://schemas.sirsidynix.com/symws/standard

Prerequisites

Valid clientID (see clientID)

Request

SearchCatalogRequest

Response

SearchCatalogResponse

Operation faults

None (see also Faults)

SearchCatalogRequest

The SearchCatalogRequest has the following request parameters:

Parameter

Type

Description

Required?

query

None

The query parameter does not need a value. It is a container for different term, searchType, and operator parameters in a request.

You can have up to 8 query entries in one request.

 

term

xs:string

Specifies your search term.

You can have up to 1024 characters in the term parameter value.

Important: In REST requests, you must number the term within a query (for example, “term1=<value>”).

Y

searchType

xs:string

Specifies the search policy type.

If you do not specify a value, the search index will default to “GENERAL” by default.

Important: In REST requests, you must number the searchTypes within a query (for example, “searchType1=<value>”).

N

operator

xs:string

Specifies one of the following enumeration values:

AND
OR
NOT
XOR

If you do not specify a value, the system will assume “AND” by default.

Important: In REST requests, you must number your search terms within a query (for example, “operator1=<value>”).

N

exactMatch

xs:boolean

Specifies if you want searches to return exact results (true), or not (false).

If you do not specify a value, the system will assume “false” by default.

N

hitsToDisplay

xs:nonNegativeInteger

Specifies the maximum amount of search results you want to return in the response.

If you do not specify a value, the system will default to 20 results.

N

filters

SearchCatalogFilters

Specifies any filters you want to apply to your catalog search.

N

includeAvailabilityInfo

xs:boolean

Specifies if you want to include availability information for items returned in the response (true), or not (false).

N

SearchCatalogResponse

The SearchCatalogResponse returns a SearchCatalogResult data type (see SearchCatalogResult).

Related topics 

 


© 2009-2012 SirsiDynix