SearchResultsService

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

General Purpose

Displays the results of the most recent search.

Requirements

Voyager 7.x and higher.

Input Parameters

Parameter	Description	Value	Default	Required
searchType	Type of search (i.e, FIND, BROWSE, RELBIBS)	string	None	Yes
resultPointer	A pointer into the result set	string		Yes
maxResultsPerPage	The maximum number of results to return	string		No
sortBy	The property by which the results are to be sorted	string		No
profileCode	The profile Code for which we retrieve related bib records	string	None	Yes

Parameters are included in the invoking URL.

The SearchService must be invoked first to establish the search result set before the SearchResultService is invoked.

For example, invoke SearchService as follows:

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

Then invoke SearchResultService to look for the second entry (entry 1, note that entry is starting from 0):

http://10.100.3.87:60414/vxws/SearchResultsService?searchType=FIND&resultPointer=1&maxResultsPerPage=10

Input URL Syntax

The search result service must be run after a previous search service because the result set is kept on the server, and the search result service can navigate through that result set backward or forward.

You must hand back the JSESSIONID cookie given as part of the result of the SearchService in order to get the next or subsequent page.

To move backwards in the result set, supply a negative resultPointer.

Substitute AAAA with search type, BBBB with result pointer, CCC with max results per page and DDD with sort by.

http://server:port/vxws/SearchResultsService?searchType=AAAA&resultPointer=BBBB&maxResultsPerPage=CCCC&sortBy=DDDD

XSD

Click here to view the ServiceParametersSchema
Click here to view the SearchSchema

Input XML Example

This service expects to receive a ServiceParametersDocument containing a the following parameters:

searchType – the searchType value returned by the SearchService.
resultPointer – a pointer into the result set of the previous search, or if the previous search had a searchType of BROWSE, then a relative pointer indicating the number of records to browse forward or backward by (i.e., +10, -20).
maxResultsPerPage – the maximum number of results to return.

Additionally, if the searchType value is FIND, the following parameter may be added to sort the result set:

sortBy – the property by which the results are to be sorted. Valid values are:
- TITLE – default sort type for searches not using relevance
- AUTHOR
- PUB_DATE
- PUB_DATE_DESC
- RELEVANCE – default sort type for searches using relevance

Additionally, if the searchType value is RELBIBS, the following parameter must be added to sort the result set:

profileCode – the profileCode for which we are retrieving related bib records.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters>
      <ser:parameter key="searchType">
         <ser:value>FIND</ser:value>
      </ser:parameter>
      <ser:parameter key="resultPointer">
         <ser:value>0</ser:value>
      </ser:parameter>
      <ser:parameter key="maxResultsPerPage">
         <ser:value>10</ser:value>
      </ser:parameter>
   </ser:parameters>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument containing a searchResultsType element which contains the results of the most recent search.

Example:

<?xml version="1.0" encoding="UTF-8" ?>
<voyagerServiceData xmlns="http://www.endinfosys.com/Voyager/serviceParameters" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <serviceData xsi:type="sear:searchResultsType" xmlns:sear="http://www.endinfosys.com/Voyager/search">
    <sear:totalHits>10</sear:totalHits>
    <sear:searchType>FIND</sear:searchType>
    <sear:bibSearchResults>
      <sear:results>
        <sear:result>
          <sear:bibId>81875</sear:bibId>
          <sear:bibText1>Everything for spring : a complete activity book for teachers of young children : activities for March, April, and May / edited by Kathy Charner ; illustrations by Joan Waites.</sear:bibText1>
          <sear:bibText2>Gryphon House,</sear:bibText2>
          <sear:bibText3>1997</sear:bibText3>
          <sear:callNumber>LB1139.35.A37 E847 1997</sear:callNumber>
          <sear:mfhdCount>1</sear:mfhdCount>
          <sear:itemCount>1</sear:itemCount>
          <sear:itemStatusCode>1</sear:itemStatusCode>
          <sear:locationName>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</sear:locationName>
          <sear:opacSuppressFlag>N</sear:opacSuppressFlag>
          <sear:relevanceRanking>68</sear:relevanceRanking>
          <sear:headingText xsi:nil="true"/>
          <sear:headingType xsi:nil="true"/>
          <sear:indexCode xsi:nil="true"/>
          <sear:databaseCode xsi:nil="true"/>
          <sear:elink xsi:nil="true"/>
          <sear:elinkType xsi:nil="true"/>
          <sear:isbn>087659187X (pbk.)</sear:isbn>
          <sear:issn xsi:nil="true"/>
          <sear:bibFormat>am</sear:bibFormat>
        </sear:result>
        <sear:result>
          <sear:bibId>81874</sear:bibId>
          <sear:bibText1>Everything for winter : a complete activity book for teachers of young children : activities for December, January, and February / edited by Kathy Charner ; illustrations by Joan Waites.</sear:bibText1>
          <sear:bibText2>Gryphon House,</sear:bibText2>
          <sear:bibText3>1997</sear:bibText3>
          <sear:callNumber xsi:nil="true"/>
          <sear:mfhdCount>2</sear:mfhdCount>
          <sear:itemCount>0</sear:itemCount>
          <sear:itemStatusCode xsi:nil="true"/>
          <sear:locationName xsi:nil="true"/>
          <sear:opacSuppressFlag>N</sear:opacSuppressFlag>
          <sear:relevanceRanking>68</sear:relevanceRanking>
          <sear:headingText xsi:nil="true"/>
          <sear:headingType xsi:nil="true"/>
          <sear:indexCode xsi:nil="true"/>
          <sear:databaseCode xsi:nil="true"/>
          <sear:elink xsi:nil="true"/>
          <sear:elinkType xsi:nil="true"/>
          <sear:isbn>0876591861 (pbk.)</sear:isbn>
          <sear:issn xsi:nil="true"/>
          <sear:bibFormat>am</sear:bibFormat>
        </sear:result>
        <sear:result>
          <sear:bibId>81726</sear:bibId>
          <sear:bibText1>Under deadman's skin : discovering the meaning of children's violent play / Jane Katch ; introduction by Vivian Gussin Paley.</sear:bibText1>
          <sear:bibText2>Beacon Press,</sear:bibText2>
          <sear:bibText3>2001</sear:bibText3>
          <sear:callNumber>HQ784.V55 K38 2001</sear:callNumber>
          <sear:mfhdCount>1</sear:mfhdCount>
          <sear:itemCount>1</sear:itemCount>
          <sear:itemStatusCode>1</sear:itemStatusCode>
          <sear:locationName>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</sear:locationName>
          <sear:opacSuppressFlag>N</sear:opacSuppressFlag>
          <sear:relevanceRanking>68</sear:relevanceRanking>
          <sear:headingText xsi:nil="true"/>
          <sear:headingType xsi:nil="true"/>
          <sear:indexCode xsi:nil="true"/>
          <sear:databaseCode xsi:nil="true"/>
          <sear:elink xsi:nil="true"/>
          <sear:elinkType xsi:nil="true"/>
          <sear:isbn>0807031283 (alk. paper)</sear:isbn>
          <sear:issn xsi:nil="true"/>
          <sear:bibFormat>am</sear:bibFormat>
        </sear:result>
        <sear:result>
          <sear:bibId>80958</sear:bibId>
          <sear:bibText1>Everything for spring : a complete activity book for teachers of young children : activities for March, April, and May / edited by Kathy Charner ; illustrations by Joan Waites.</sear:bibText1>
          <sear:bibText2>Gryphon House,</sear:bibText2>
          <sear:bibText3>1997</sear:bibText3>
          <sear:callNumber>LB1139.35.A37 E847 1997</sear:callNumber>
          <sear:mfhdCount>1</sear:mfhdCount>
          <sear:itemCount>1</sear:itemCount>
          <sear:itemStatusCode>1</sear:itemStatusCode>
          <sear:locationName>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</sear:locationName>
          <sear:opacSuppressFlag>N</sear:opacSuppressFlag>
          <sear:relevanceRanking>68</sear:relevanceRanking>
          <sear:headingText xsi:nil="true"/>
          <sear:headingType xsi:nil="true"/>
          <sear:indexCode xsi:nil="true"/>
          <sear:databaseCode xsi:nil="true"/>
          <sear:elink xsi:nil="true"/>
          <sear:elinkType xsi:nil="true"/>
          <sear:isbn>087659187X (pbk.)</sear:isbn>
          <sear:issn xsi:nil="true"/>
          <sear:bibFormat>am</sear:bibFormat>
        </sear:result>
        <sear:result>
          <sear:bibId>80957</sear:bibId>
          <sear:bibText1>Everything for winter : a complete activity book for teachers of young children : activities for December, January, and February / edited by Kathy Charner ; illustrations by Joan Waites.</sear:bibText1>
          <sear:bibText2>Gryphon House,</sear:bibText2>
          <sear:bibText3>1997</sear:bibText3>
          <sear:callNumber>LB1139.35.A37 E85 1997</sear:callNumber>
          <sear:mfhdCount>1</sear:mfhdCount>
          <sear:itemCount>1</sear:itemCount>
          <sear:itemStatusCode>1</sear:itemStatusCode>
          <sear:locationName>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</sear:locationName>
          <sear:opacSuppressFlag>N</sear:opacSuppressFlag>
          <sear:relevanceRanking>68</sear:relevanceRanking>
          <sear:headingText xsi:nil="true"/>
          <sear:headingType xsi:nil="true"/>
          <sear:indexCode xsi:nil="true"/>
          <sear:databaseCode xsi:nil="true"/>
          <sear:elink xsi:nil="true"/>
          <sear:elinkType xsi:nil="true"/>
          <sear:isbn>0876591861 (pbk.)</sear:isbn>
          <sear:issn xsi:nil="true"/>
          <sear:bibFormat>am</sear:bibFormat>
        </sear:result>
        <sear:result>
          <sear:bibId>76945</sear:bibId>
          <sear:bibText1>Under deadman's skin : discovering the meaning of children's violent play / Jane Katch ; introduction by Vivian Gussin Paley.</sear:bibText1>
          <sear:bibText2>Beacon Press,</sear:bibText2>
          <sear:bibText3>2001</sear:bibText3>
          <sear:callNumber>HQ784.V55 K38 2001</sear:callNumber>
          <sear:mfhdCount>1</sear:mfhdCount>
          <sear:itemCount>0</sear:itemCount>
          <sear:itemStatusCode xsi:nil="true"/>
          <sear:locationName>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</sear:locationName>
          <sear:opacSuppressFlag>N</sear:opacSuppressFlag>
          <sear:relevanceRanking>68</sear:relevanceRanking>
          <sear:headingText xsi:nil="true"/>
          <sear:headingType xsi:nil="true"/>
          <sear:indexCode xsi:nil="true"/>
          <sear:databaseCode xsi:nil="true"/>
          <sear:elink xsi:nil="true"/>
          <sear:elinkType xsi:nil="true"/>
          <sear:isbn>0807031283 (alk. paper)</sear:isbn>
          <sear:issn xsi:nil="true"/>
          <sear:bibFormat>am</sear:bibFormat>
        </sear:result>
        <sear:result>
          <sear:bibId>76177</sear:bibId>
          <sear:bibText1>Everything for spring : a complete activity book for teachers of young children : activities for March, April, and May / edited by Kathy Charner ; illustrations by Joan Waites.</sear:bibText1>
          <sear:bibText2>Gryphon House,</sear:bibText2>
          <sear:bibText3>1997</sear:bibText3>
          <sear:callNumber xsi:nil="true"/>
          <sear:mfhdCount>2</sear:mfhdCount>
          <sear:itemCount>0</sear:itemCount>
          <sear:itemStatusCode xsi:nil="true"/>
          <sear:locationName xsi:nil="true"/>
          <sear:opacSuppressFlag>N</sear:opacSuppressFlag>
          <sear:relevanceRanking>68</sear:relevanceRanking>
          <sear:headingText xsi:nil="true"/>
          <sear:headingType xsi:nil="true"/>
          <sear:indexCode xsi:nil="true"/>
          <sear:databaseCode xsi:nil="true"/>
          <sear:elink xsi:nil="true"/>
          <sear:elinkType xsi:nil="true"/>
          <sear:isbn>087659187X (pbk.)</sear:isbn>
          <sear:issn xsi:nil="true"/>
          <sear:bibFormat>am</sear:bibFormat>
        </sear:result>
      </sear:results>
    </sear:bibSearchResults>
</voyagerServiceData>