SearchService

Ex Libris Developer Network Voyager Documentation Voyager APIs XML over HTTP Web Services SearchService

General Purpose

Displays the results of the search.

Requirements

Voyager 7.x and higher.

Input Parameters

Parameter	Description	Value	Default	Required
searchCode	Type of search (i.e, GKEY)	string	None	Yes
searchArg		string		Yes
maxResultsPerPage	The maximum number of results to return	string		No
searchArgType	The searchArgType is an additional string associated with the search code or search argument. Its values are AND, OR (for search code like GKEY), and ANY, ALL, PHRASE to describe if any, or all word of the search argument is used, or the search argument is used as a phrase for the search.	string	AND	No
browseFlag	Optional argument indicates if this is a browse search (Y) or not (N)	string	N	No
relevanceFlag	Optional argument indicates if the search is ranked by relevance (Y) or not (N) .This is the same as the * for the relevance ranking. If input URL syntax is using, this variable name is displayRelevanceFlag.	string	N	No
headingsKeywordFlag	Optional argument indicates if this is headings keyword search (Y) or (N). This is equivalent to the @ headings keyword search that looks for the search argument in any where.	string	N	No

Parameters are included in the invoking URL.

After the search, please use the SearchResultService with the resultPointer parameter to go to a specific section of the search result.
For example, use the following after a browse search to go back 4 title:

http://10.100.3.87:60414/vxws/SearchResultsService?searchType=BROWSE&resultPointer=-4&maxResultsPerPage=10

Input URL Syntax

This web service can be called by GET or POST methods. If it is called by GET method then include these parameters in the URL

The following is an example of doing a keyword search:

http://10.100.2.37:30114/vxws/SearchService?searchCode=GKEY&searchArg=CAT&maxResultsPerPage=10&searchArgType=AND

The following is an example of doing the same keyword search as above ranked by relevance:

http://10.100.2.37:30114/vxws/SearchService?searchCode=GKEY&searchArg=CAT&maxResultsPerPage=10&searchArgType=AND&displayRelevanceFlag=Y

The following is an example of doing a browse search:

http://10.100.2.37:30114/vxws/SearchService?searchCode=CALL&searchArg=CAT&maxResultsPerPage=10&searchArgType=AND&browseFlag=Y

The following is an example of doing a headings search with index AUTH:

http://10.100.2.37:30114/vxws/SearchService?searchCode=AUTH&searchArg=john&maxResultsPerPage=10&searchArgType=AND

The following is an example of doing a headings keyword search with index AUTH:

http://10.100.2.37:30114/vxws/SearchService?searchCode=AUTH&searchArg=john&maxResultsPerPage=10&searchArgType=AND&headingsKeywordFlag=Y

XSD

Click here to view the SearchSchema

Input XML Example

This service expects to receive a ServiceParametersDocument containing a searchDefinition element which must contain a searchComponents element and a maxResultsPerPage element.

OPAC search logging (the searchlogging parameter) is optional and can be omitted from the search service invocation. The search logging feature logs the search history into the OPAC_SEARCH_LOG table in the database, and customers can analyze this data to determine usage statistics, how patrons are searching the catalog, discovery patterns, etc. Please refer to the Voyager(r) 7.0 technical user’s guide.

<statString> = vwebv.properties search.status.id; VWEBV en_US is default
<sessionId> = date/time the search is executed in the format of YYYYMMDDHHMISSSSS 4-digit year 2-digit month 2-digit day 2-digit hour (24 hour format) 2-digit minute 2-digit second 3-digit milli-second
<searchType> = type of search to be performed
<clientIP> = HTTP request IP address where the search request originated

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters/>
   <ser:definedParameters xsi:type="sear:searchDefinitionType" xmlns:sear="http://www.endinfosys.com/Voyager/search" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <sear:searchComponents>
         <sear:searchComponent>
            <sear:searchArg>car</sear:searchArg>
            <sear:searchCode>GKEY</sear:searchCode>
            <sear:searchArgType>AND</sear:searchArgType>
         </sear:searchComponent>
      </sear:searchComponents>
      <sear:searchLogging>
         <sear:statString>VWEBV en_US</sear:statString>
         <sear:sessionId>2008081315531177</sear:sessionId>
         <sear:searchType>GKEY</sear:searchType>
         <sear:clientIP>127.0.0.1</sear:clientIP>
      </sear:searchLogging>
      <sear:maxResultsPerPage>10</sear:maxResultsPerPage>
      <sear:relevanceFlag>Y</sear:relevanceFlag>
   </ser:definedParameters>
</ser:serviceParameters>

This is an example of a multi-term search, GKEY for 0060205903 or 0027496112:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters/>
   <ser:definedParameters xsi:type="sear:searchDefinitionType" xmlns:sear="http://www.endinfosys.com/Voyager/search" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <sear:searchComponents>
         <sear:searchComponent>
            <sear:searchArg>0060205903</sear:searchArg>
            <sear:searchCode>GKEY</sear:searchCode>
            <sear:searchArgType>ANY</sear:searchArgType>
         </sear:searchComponent>
         <sear:searchComponent>
            <sear:searchArg>0027496112</sear:searchArg>
            <sear:searchCode>GKEY</sear:searchCode>
            <sear:searchArgType>ANY</sear:searchArgType>
            <sear:combineWithPrevious>OR</sear:combineWithPrevious>
         </sear:searchComponent>
      </sear:searchComponents>
      <sear:searchLogging>
         <sear:statString>VWEBV en_US</sear:statString>
         <sear:sessionId>2008081315531177</sear:sessionId>
         <sear:searchType>ADVANCED</sear:searchType>
         <sear:clientIP>127.0.0.1</sear:clientIP>
      </sear:searchLogging>
      <sear:maxResultsPerPage>10</sear:maxResultsPerPage>
      <sear:relevanceFlag>Y</sear:relevanceFlag>
   </ser:definedParameters>
</ser:serviceParameters>

The most important parts are the

<sear:combineWithPrevious>OR</sear:combineWithPrevious>

which could be OR or AND, and

<sear:searchType>ADVANCED</sear:searchType>