SearchPropertiesService

General Purpose

Use to retrieve the search properties.

Requirements

Voyager 7.x and higher.

Input URL Syntax

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

http://server:port/vxws/SearchPropertiesService

Input XML Example

This service expects to receive a ServiceParametersDocument containing the following optional parameter:

  • clientIP – the end user’s client IP address.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters>
      <ser:parameter key="clientIP">
         <ser:value>127.0.0.1</ser:value>
      </ser:parameter>
   </ser:parameters>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument containing a searchPropertiesType element which contains searchDatabases, searchTypes, searchLimits, and mapSearchProperties data.

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:searchPropertiesType" xmlns:sear="http://www.endinfosys.com/Voyager/search">
    <sear:searchDatabases>
      <sear:searchDatabase>
        <sear:code>KC70DB</sear:code>
        <sear:name>MBL/WHOI Library</sear:name>
        <sear:description>MBL/WHOI Library</sear:description>
        <sear:protocol>V</sear:protocol>
        <sear:address>10.111.111.96</sear:address>
        <sear:type>B</sear:type>
        <sear:port>37000</sear:port>
        <sear:gids/>
      </sear:searchDatabase>
      <sear:searchDatabase>
        <sear:code>MEDL</sear:code>
        <sear:name>Medline</sear:name>
        <sear:description>Medline</sear:description>
        <sear:protocol>Z</sear:protocol>
        <sear:address>204.179.122.51</sear:address>
        <sear:type>C</sear:type>
        <sear:port>2990</sear:port>
        <sear:gids/>
      </sear:searchDatabase>
      <sear:searchDatabase>
        <sear:code>LOCAL</sear:code>
        <sear:name>dev70ncdb - SysAdmin db def name</sear:name>
        <sear:description>dev70ncdb - SysAdmin db def desc</sear:description>
        <sear:protocol>V</sear:protocol>
        <sear:address>10.111.111.96</sear:address>
        <sear:type>B</sear:type>
        <sear:port>39100</sear:port>
        <sear:gids/>
      </sear:searchDatabase>
      <sear:searchDatabase>
        <sear:code>KC71NCDB</sear:code>
        <sear:name>dev71ncdb</sear:name>
        <sear:description>dev71ncdb</sear:description>
        <sear:protocol>V</sear:protocol>
        <sear:address>10.111.111.96</sear:address>
        <sear:type>B</sear:type>
        <sear:port>39100</sear:port>
        <sear:gids/>
      </sear:searchDatabase>
    </sear:searchDatabases>
    <sear:searchTypes>
      <sear:searchType>
        <sear:searchName>Keyword Anywhere</sear:searchName>
        <sear:searchCode>GKEY</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>OPAC Geospatial Search</sear:searchName>
        <sear:searchCode>MAPS</sear:searchCode>
        <sear:searchType>M</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>Mfhd Call Number</sear:searchName>
        <sear:searchCode>CALL</sear:searchCode>
        <sear:searchType>U</sear:searchType>
      </sear:searchType>
    </sear:searchTypes>