SearchConnectionService

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

General Purpose

Manages connections to the databases that will be searched by the SearchService.

Requirements

Voyager 7.x and higher.

Input URL Syntax

This service expects to receive an XML document via POST method.

http://server:port/vxws/SearchConnectionService

XSD

Click here to view the ServiceParametersSchema

Input XML Example

This service expects to receive a ServiceParametersDocument containing a connectDBCodes parameter, which contains a list of database codes that the user wishes to connect to, and a disconnectDBCodes parameter, which contains a list of database codes that the user no longer wishes to be connected to.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters>
      <ser:parameter key="connectDBCodes">
         <ser:value>KC70DB</ser:value>
         <ser:value>ECON</ser:value>
      </ser:parameter>
      <ser:parameter key="disconnectDBCodes">
         <ser:value>LOCAL</ser:value>
      </ser:parameter>
   </ser:parameters>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument containing a connectionStatus element which contains a databaseStatus element containing a list of statuses for the new connections (if any) and a searchTypes element containing a list of searches available in the current combination of connected databases.

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:connectionStatusType" xmlns:sear="http://www.endinfosys.com/Voyager/search">
    <sear:databaseStatus>
      <sear:status>
        <sear:databaseCode>ECON</sear:databaseCode>
        <sear:databaseName>EconLit</sear:databaseName>
        <sear:primaryStatus>6</sear:primaryStatus>
        <sear:secondaryStatus>0</sear:secondaryStatus>
      </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:status>
    </sear:databaseStatus>
    <sear:searchTypes>
      <sear:searchType>
        <sear:searchName>Abstract</sear:searchName>
        <sear:searchCode>ABST</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>Author Name</sear:searchName>
        <sear:searchCode>NKEY</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>Date, Publisher or Place</sear:searchName>
        <sear:searchCode>IMPR</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>Date/Time of Event (see Help)</sear:searchName>
        <sear:searchCode>033A</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>Geographic Coordinates (see Help)</sear:searchName>
        <sear:searchCode>034D</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>ISBN</sear:searchName>
        <sear:searchCode>ISBN</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>ISSN</sear:searchName>
        <sear:searchCode>ISSN</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>Keyword Anywhere</sear:searchName>
        <sear:searchCode>GKEY</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>OPAC Geospatial Search</sear:searchName>
        <sear:searchCode>MAPS</sear:searchCode>
        <sear:searchType>M</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>Series</sear:searchName>
        <sear:searchCode>SERI</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>Subject xyz</sear:searchName>
        <sear:searchCode>SKEY</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>Title</sear:searchName>
        <sear:searchCode>TKEY</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>URL &amp; Link Text</sear:searchName>
        <sear:searchCode>856U</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>asp</sear:searchName>
        <sear:searchCode>ASP</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
      <sear:searchType>
        <sear:searchName>test 880</sear:searchName>
        <sear:searchCode>880</sear:searchCode>
        <sear:searchType>K</sear:searchType>
      </sear:searchType>
    </sear:searchTypes>
  </serviceData>
</voyagerServiceData>