SearchStatusService

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

General Purpose

Stores a snapshot of the status of the current search.

Requirements

Voyager 7.x and higher.

Input URL Syntax

This web service can’t be called by GET or POST methods alone. This service is called from the search service for simul search.

http://server:port/vxws/SearchStatusService

XSD

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

Output XML Example

This service will return a VoyagerServiceDataDocument containing a searchStatusType element which contains a snapshot of the 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>LOCAL</sear:databaseCode>
        <sear:databaseName>dev70ncdb - SysAdmin db def name</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: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>