CourseReservePropertiesService

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

General Purpose

Use the course reserve search to locate items placed on reserve in Dropdown list page format.

Requirements

Voyager 7.x and higher.

Input URL Syntax

This service expects to receive via POST method.

http://server:port/vxws/CourseReservePropertiesService

XSD

Click here to view the ServiceParametersSchema
Click here to view the ServiceDataSchema

Input XML Example

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

  1. clusterId – a compound cluster id. can also be “0” to indicate “all clusters” or null to get a list of available clusters.
  2. locationId – a browse location id. can also be “0” to indicate “all locations” or null to get a list of available browse locations.
  3. browseFlag – set to Y to indicate course reserve browse mode. Defaults to N.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters>
      <ser:parameter key="clusterId">
         <ser:value>1@QA20012DB20020613131313</ser:value>
      </ser:parameter>
      <ser:parameter key="locationId">
         <ser:value>0</ser:value>
      </ser:parameter>
      <ser:parameter key="browseFlag">
         <ser:value>N</ser:value>
      </ser:parameter>
   </ser:parameters>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument containing a CourseReservePropertiesDocument which contains information necessary to define a course reserve 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:courseReservePropertiesType" xmlns:sear="http://www.endinfosys.com/Voyager/search">
    <sear:selectedClusterId>0</sear:selectedClusterId>
    <sear:reserveData>
      <sear:activeCourses>
        <sear:course>
          <sear:id>35</sear:id>
          <sear:name>Photo Basics</sear:name>
          <sear:number>101</sear:number>
          <sear:clusterId>1</sear:clusterId>
        </sear:course>
        <sear:course>
          <sear:id>40</sear:id>
          <sear:name>Quantum Tunnels</sear:name>
          <sear:number>101</sear:number>
          <sear:clusterId>1</sear:clusterId>
        </sear:course>
        <sear:course>
          <sear:id>36</sear:id>
          <sear:name>1234567890abcdefg</sear:name>
          <sear:number>1234567890</sear:number>
          <sear:clusterId>1</sear:clusterId>
        </sear:course>
        <sear:course>
          <sear:id>1</sear:id>
          <sear:name>Human Biology</sear:name>
          <sear:number>BIO:700</sear:number>
          <sear:clusterId>1</sear:clusterId>
        </sear:course>
        <sear:course>
          <sear:id>17</sear:id>
          <sear:name>Intro to Experimental  Biology</sear:name>
          <sear:number>BIO:712</sear:number>
          <sear:clusterId>1</sear:clusterId>
        </sear:course>
        <sear:course>
          <sear:id>19</sear:id>
          <sear:name>Cell Biology</sear:name>
          <sear:number>BIO:760</sear:number>
          <sear:clusterId>1</sear:clusterId>
        </sear:course>
      </sear:activeCourses>
      <sear:activeDepartments>
        <sear:department>
          <sear:id>12</sear:id>
          <sear:name>Philosophy</sear:name>
          <sear:code>66</sear:code>
          <sear:clusterId>1</sear:clusterId>
        </sear:department>
        <sear:department>
          <sear:id>1</sear:id>
          <sear:name>Biology</sear:name>
          <sear:code>BIO</sear:code>
          <sear:clusterId>1</sear:clusterId>
        </sear:department>
        <sear:department>
          <sear:id>24</sear:id>
          <sear:name>Aperture Science</sear:name>
          <sear:code>HL2</sear:code>
          <sear:clusterId>1</sear:clusterId>
        </sear:department>
        <sear:department>
          <sear:id>25</sear:id>
          <sear:name>Animal Testing</sear:name>
          <sear:code>OUCH</sear:code>
          <sear:clusterId>1</sear:clusterId>
        </sear:department>
      </sear:activeDepartments>
      <sear:activeInstructors>
        <sear:instructor>
          <sear:id>1</sear:id>
          <sear:lastName>Arms</sear:lastName>
          <sear:firstName>Michele</sear:firstName>
          <sear:title>Dr.</sear:title>
          <sear:clusterId>1</sear:clusterId>
        </sear:instructor>
        <sear:instructor>
          <sear:id>36</sear:id>
          <sear:lastName>Dolittle</sear:lastName>
          <sear:firstName>John</sear:firstName>
          <sear:title>Dr.</sear:title>
          <sear:clusterId>1</sear:clusterId>
        </sear:instructor>
        <sear:instructor>
          <sear:id>35</sear:id>
          <sear:lastName>Johson</sear:lastName>
          <sear:firstName>Cave</sear:firstName>
          <sear:title>Dr.</sear:title>
          <sear:clusterId>1</sear:clusterId>
        </sear:instructor>
        <sear:instructor>
          <sear:id>34</sear:id>
          <sear:lastName>Sellers</sear:lastName>
          <sear:firstName>David</sear:firstName>
          <sear:title>Mr.</sear:title>
          <sear:clusterId>1</sear:clusterId>
        </sear:instructor>
      </sear:activeInstructors>
      <sear:activeSections>
        <sear:section>
          <sear:id>1</sear:id>
          <sear:number>1</sear:number>
          <sear:numberStudents>100</sear:numberStudents>
          <sear:clusterId>1</sear:clusterId>
        </sear:section>
        <sear:section>
          <sear:id>2</sear:id>
          <sear:number>1</sear:number>
          <sear:numberStudents>25</sear:numberStudents>
          <sear:clusterId>1</sear:clusterId>
        </sear:section>
        <sear:section>
          <sear:id>10</sear:id>
          <sear:number>666-1</sear:number>
          <sear:numberStudents>25</sear:numberStudents>
          <sear:clusterId>1</sear:clusterId>
        </sear:section>
        <sear:section>
          <sear:id>14</sear:id>
          <sear:number>Sectiön</sear:number>
          <sear:numberStudents>666</sear:numberStudents>
          <sear:clusterId>1</sear:clusterId>
        </sear:section>
        <sear:section>
          <sear:id>17</sear:id>
          <sear:number>Tier 3</sear:number>
          <sear:numberStudents>47</sear:numberStudents>
          <sear:clusterId>1</sear:clusterId>
        </sear:section>
      </sear:activeSections>
    </sear:reserveData>
  </serviceData>
</voyagerServiceData>