StopSearchService

NAVIGATE CONTENT
Ex Libris Developer Network Voyager Documentation Voyager APIs XML over HTTP Web Services StopSearchService

General Purpose

Stops the current simul-search operation.

Requirements

Voyager 7.1.0.x and higher.
The search needs to be performed first in the same session.

Input URL Syntax

http://server:port/vxws/StopSearchService

XSD

Click here to view the ServiceDataSchema

Input XML Example

This service has no input parameters.

Output XML Example

This service will return a VoyagerServiceDataDocument containing a searchStatusType element which contains a snapshot of the final status of the current 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:searchStatusType" xmlns:sear="http://www.endinfosys.com/Voyager/search">
    <sear:resultsAvailable>N</sear:resultsAvailable>
    <sear:lastResultSent>Y</sear:lastResultSent>
    <sear:totalHits>0</sear:totalHits>
    <sear:searchStatuses>
      <sear:status>
        <sear:databaseCode>ECON</sear:databaseCode>
        <sear:databaseName>EconLit</sear:databaseName>
        <sear:primaryStatus>6</sear:primaryStatus>
        <sear:secondaryStatus>0</sear:secondaryStatus>
        <sear:databaseType>Z</sear:databaseType>
        <sear:percentDone>100</sear:percentDone>
        <sear:hitCount>0</sear:hitCount>
      </sear:status>
      <sear:status>
        <sear:databaseCode>KC70DB</sear:databaseCode>
        <sear:databaseName>MBL/WHOI Library</sear:databaseName>
        <sear:primaryStatus>6</sear:primaryStatus>
        <sear:secondaryStatus>0</sear:secondaryStatus>
        <sear:databaseType>V</sear:databaseType>
        <sear:percentDone>100</sear:percentDone>
        <sear:hitCount>0</sear:hitCount>
      </sear:status>
    </sear:searchStatuses>
  </serviceData>
</voyagerServiceData>