SearchPreferencesService

General Purpose

To get, clear, or set a patron’s search preferences.

Requirements

Voyager 7.x and higher.

Input URL Syntax

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

http://server:port/vxws/SearchPreferencesService

Input XML Example

This service expects to receive via POST method a ServiceParametersDocument containing a patronIdentifier and the parameters defined below:

  • action – defines which action the service is to provide. Must be one of “get” or “clear” or “set” If the action parameter is “set” then the ServiceParametersDocument must also contain a definedParameter of PreferencesType containing the patron’s search preferences. Within PreferencesType, the following elements are always required:
  • defaultSearchForm – a value indicating the patron’s default search form. Must be one of the following values:
    • “1” – indicates Basic search form
    • “2” – indicates Advanced search form
    • “3” – indicates Subject search form
    • “4” – indicates Author search form
    • “5” – indicates Course Reserve search form
    • “6” – indicates Geospatial search form
  • resultsPerPage – a value indicating the desired maximum number of search results displayed per page. If the defaultSearchForm value is “1” then the following element is also required:
  • defaultSearchCode – the patron’s default search code. Value to be obtained from searchPreferences><searchTypes><searchType><searchCode> selection. If the defaultSearchForm value is “5” then the following elements are also required:
  • defaultCourseId – value can be “0” to indicate “any” or to be obtained from <searchPreferences><reserveData><activeCourses><course><id> selection.
  • defaultDepartmentId – value can be “0” to indicate “any” or to be obtained from <searchPreferences><reserveData><activeDepartments><department><id> selection.
  • defaultInstructorId – value can be “0” to indicate “any” or to be obtained from <searchPreferences><reserveData><activeInstructors><instructor><id> selection.
  • defaultSectionId – value can be “0” to indicate “any” or to be obtained from <searchPreferences><reserveData><activeSections><section><id> selection. There is also an optional defaultDatabases element which should contain the patron’s selection of default search databases. For each selected database, defaultDatabases must contain a database element containing a code element, specifying the selected database code. This value is to be obtained from <searchPreferences><searchDatabases><searchDatabase><code> selection.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters>
      <ser:parameter key="action">
         <ser:value>set</ser:value>
      </ser:parameter>
   </ser:parameters>
   <ser:patronIdentifier lastName="Patel" patronHomeUbId="1@QA20012DB20020613131313" patronId="562">
      <ser:authFactor type="B">150</ser:authFactor>
   </ser:patronIdentifier>
   <ser:definedParameters xsi:type="pat:preferencesType" xmlns:pat="http://www.endinfosys.com/Voyager/patronPreferences" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <pat:defaultSearchForm>1</pat:defaultSearchForm>
      <pat:defaultSearchCode>GKEY^*</pat:defaultSearchCode>
      <pat:defaultCourseId>0</pat:defaultCourseId>
      <pat:defaultDepartmentId>0</pat:defaultDepartmentId>
      <pat:defaultInstructorId>0</pat:defaultInstructorId>
      <pat:defaultSectionId>0</pat:defaultSectionId>
      <pat:resultsPerPage>10</pat:resultsPerPage>
   </ser:definedParameters>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument wrapping a SearchPreferencesType element, which contains the patron’s search preferences, and other information necessary to set the patron’s search preferences.

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="pat:searchPreferencesType" xmlns:pat="http://www.endinfosys.com/Voyager/patronPreferences">
    <pat:preferences>
      <pat:defaultDatabases/>
      <pat:defaultSearchForm>1</pat:defaultSearchForm>
      <pat:defaultSearchCode>GKEY^*</pat:defaultSearchCode>
      <pat:resultsPerPage>10</pat:resultsPerPage>
    </pat:preferences>
    <pat:reserveData>
      <pat:activeCourses>
        <pat:course>
          <pat:id>35</pat:id>
          <pat:name>Photo Basics</pat:name>
          <pat:number>101</pat:number>
          <pat:clusterId>1</pat:clusterId>
        </pat:course>
        <pat:course>
          <pat:id>40</pat:id>
          <pat:name>Quantum Tunnels</pat:name>
          <pat:number>101</pat:number>
          <pat:clusterId>1</pat:clusterId>
        </pat:course>
        <pat:course>
          <pat:id>36</pat:id>
          <pat:name>1234567890abcdefg</pat:name>
          <pat:number>1234567890</pat:number>
          <pat:clusterId>1</pat:clusterId>
        </pat:course>
        <pat:course>
          <pat:id>1</pat:id>
          <pat:name>Human Biology</pat:name>
          <pat:number>BIO:700</pat:number>
          <pat:clusterId>1</pat:clusterId>
        </pat:course>
        <pat:course>
          <pat:id>17</pat:id>
          <pat:name>Intro to Experimental  Biology</pat:name>
          <pat:number>BIO:712</pat:number>
          <pat:clusterId>1</pat:clusterId>
        </pat:course>
        <pat:course>
          <pat:id>19</pat:id>
          <pat:name>Cell Biology</pat:name>
          <pat:number>BIO:760</pat:number>
          <pat:clusterId>1</pat:clusterId>
        </pat:course>
      </pat:activeCourses>
      <pat:activeDepartments>
        <pat:department>
          <pat:id>12</pat:id>
          <pat:name>Philosophy</pat:name>
          <pat:code>66</pat:code>
          <pat:clusterId>1</pat:clusterId>
        </pat:department>
        <pat:department>
          <pat:id>1</pat:id>
          <pat:name>Biology</pat:name>
          <pat:code>BIO</pat:code>
          <pat:clusterId>1</pat:clusterId>
        </pat:department>
        <pat:department>
          <pat:id>24</pat:id>
          <pat:name>Aperture Science</pat:name>
          <pat:code>HL2</pat:code>
          <pat:clusterId>1</pat:clusterId>
        </pat:department>
        <pat:department>
          <pat:id>25</pat:id>
          <pat:name>Animal Testing</pat:name>
          <pat:code>OUCH</pat:code>
          <pat:clusterId>1</pat:clusterId>
        </pat:department>
      </pat:activeDepartments>
      <pat:activeInstructors>
        <pat:instructor>
          <pat:id>1</pat:id>
          <pat:lastName>Arms</pat:lastName>
          <pat:firstName>Michele</pat:firstName>
          <pat:title>Dr.</pat:title>
          <pat:clusterId>1</pat:clusterId>
        </pat:instructor>
        <pat:instructor>
          <pat:id>36</pat:id>
          <pat:lastName>Dolittle</pat:lastName>
          <pat:firstName>John</pat:firstName>
          <pat:title>Dr.</pat:title>
          <pat:clusterId>1</pat:clusterId>
        </pat:instructor>
        <pat:instructor>
          <pat:id>35</pat:id>
          <pat:lastName>Johson</pat:lastName>
          <pat:firstName>Cave</pat:firstName>
          <pat:title>Dr.</pat:title>
          <pat:clusterId>1</pat:clusterId>
        </pat:instructor>
        <pat:instructor>
          <pat:id>34</pat:id>
          <pat:lastName>Sellers</pat:lastName>
          <pat:firstName>David</pat:firstName>
          <pat:title>Mr.</pat:title>
          <pat:clusterId>1</pat:clusterId>
        </pat:instructor>
      </pat:activeInstructors>
      <pat:activeSections>
        <pat:section>
          <pat:id>1</pat:id>
          <pat:number>1</pat:number>
          <pat:numberStudents>100</pat:numberStudents>
          <pat:clusterId>1</pat:clusterId>
        </pat:section>
        <pat:section>
          <pat:id>2</pat:id>
          <pat:number>1</pat:number>
          <pat:numberStudents>25</pat:numberStudents>
          <pat:clusterId>1</pat:clusterId>
        </pat:section>
        <pat:section>
          <pat:id>10</pat:id>
          <pat:number>666-1</pat:number>
          <pat:numberStudents>25</pat:numberStudents>
          <pat:clusterId>1</pat:clusterId>
        </pat:section>
        <pat:section>
          <pat:id>14</pat:id>
          <pat:number>Sectiön</pat:number>
          <pat:numberStudents>666</pat:numberStudents>
          <pat:clusterId>1</pat:clusterId>
        </pat:section>
        <pat:section>
          <pat:id>17</pat:id>
          <pat:number>Tier 3</pat:number>
          <pat:numberStudents>47</pat:numberStudents>
          <pat:clusterId>1</pat:clusterId>
        </pat:section>
      </pat:activeSections>
    </pat:reserveData>
    <pat:searchDatabases>
      <pat:searchDatabase>
        <pat:code>CINAHL</pat:code>
        <pat:name>CINAHL</pat:name>
        <pat:description>Cumulative Index to Nursing and Allied Health Literature</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>204.179.122.51</pat:address>
        <pat:type>C</pat:type>
        <pat:port>2990</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>ECON</pat:code>
        <pat:name>EconLit</pat:name>
        <pat:description>Economic literature from the American Economic Association</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>204.179.122.51</pat:address>
        <pat:type>C</pat:type>
        <pat:port>2990</pat:port>
        <pat:gids>4|14</pat:gids>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>KC31Z</pat:code>
        <pat:name>KC20031DB Z3950</pat:name>
        <pat:description>KC20031DB Z3950</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>10.111.111.96</pat:address>
        <pat:type>B</pat:type>
        <pat:port>7290</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>LOCZ</pat:code>
        <pat:name>Library of Congress z39.50</pat:name>
        <pat:description>Library of Congress z39.50</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>z3950.loc.gov</pat:address>
        <pat:type>B</pat:type>
        <pat:port>7090</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>KC70DB</pat:code>
        <pat:name>MBL/WHOI Library</pat:name>
        <pat:description>MBL/WHOI Library</pat:description>
        <pat:protocol>V</pat:protocol>
        <pat:address>10.111.111.96</pat:address>
        <pat:type>B</pat:type>
        <pat:port>37000</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>MEDL</pat:code>
        <pat:name>Medline</pat:name>
        <pat:description>Medline</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>204.179.122.51</pat:address>
        <pat:type>C</pat:type>
        <pat:port>2990</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>NW</pat:code>
        <pat:name>Northwestern University z39.50</pat:name>
        <pat:description>Northwestern Univ. z39.50</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>129.105.213.80</pat:address>
        <pat:type>B</pat:type>
        <pat:port>11090</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>PSYF</pat:code>
        <pat:name>PsycINFO</pat:name>
        <pat:description>Citations from Psychological Abstracts</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>204.179.122.51</pat:address>
        <pat:type>C</pat:type>
        <pat:port>2990</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>PURDUEZ</pat:code>
        <pat:name>Purdue z39.50 (wlafdb)</pat:name>
        <pat:description>Purdue z39.50</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>128.210.126.190</pat:address>
        <pat:type>B</pat:type>
        <pat:port>10090</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>ZQA20011</pat:code>
        <pat:name>QA20011DB Z3950</pat:name>
        <pat:description>QA20011DB Z3950</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>10.111.111.99</pat:address>
        <pat:type>B</pat:type>
        <pat:port>9090</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>AIX31DB</pat:code>
        <pat:name>QA20031DB on Ragingwolf</pat:name>
        <pat:description>QA20031DB on Ragingwolf</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>10.100.2.30</pat:address>
        <pat:type>B</pat:type>
        <pat:port>15090</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>RLIN</pat:code>
        <pat:name>RLIN</pat:name>
        <pat:description/>
        <pat:protocol>Z</pat:protocol>
        <pat:address>zinc.rlg.org</pat:address>
        <pat:type>B</pat:type>
        <pat:port>200</pat:port>
        <pat:gids/>
      </pat:searchDatabase>
      <pat:searchDatabase>
        <pat:code>SILV</pat:code>
        <pat:name>SilverPlatter</pat:name>
        <pat:description>Citation Database</pat:description>
        <pat:protocol>Z</pat:protocol>
        <pat:address>zorro.silverplatter.com</pat:address>
        <pat:type>C</pat:type>
    ...