ReserveBrowseSearch
General Purpose
Use the course reserve search to locate items placed on reserve in browse format.
Requirements
Voyager 7.x and higher.
Input Parameters
Parameter | Description | Value | Default | Required |
---|---|---|---|---|
browseType | Department, Instructor, or Course | string | None | Yes |
letter | First letter of the Instructor, Department, or Course | string | Yes | |
clusterId | compound cluster id | string | Yes | |
locationId | browse location id | string | None | Yes |
Parameters are included in the invoking URL.
Input URL Syntax
Substitute WWWW with the browse type, XXXX with the letter, YYYY with the cluster id and ZZZZ with the location id.
http://server:port/vxws/ReserveBrowseService?browseType=WWWW&letter=XXXX&clusterId=YYYY&locationId=ZZZZ
Input XML Example
This service expects to receive a ServiceParametersDocument containing a searchDefinition element which contains a reserveBrowseComponent element and the following parameters:
- browseType –
- letter –
- clusterId – a compound cluster id. can also be “0” to indicate “all clusters” or null to get a list of available clusters.
- locationId – a browse location id. can also be “0” to indicate “all locations” or null to get a list of available browse locations.
Example:
<?xml version="1.0" encoding="UTF-8"?> <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters"> <ser:parameters/> <ser:definedParameters xsi:type="sear:searchDefinitionType" xmlns:sear="http://www.endinfosys.com/Voyager/search" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <sear:reserveBrowseComponents> <sear:browseType>DEPARTMENT</sear:browseType> <sear:letter>P</sear:letter> <sear:clusterId>1@QA20012DB20020613131313</sear:clusterId> <sear:locationId>3</sear:locationId> </sear:reserveBrowseComponents> <sear:searchLogging> <sear:statString>VWEBV en_US</sear:statString> <sear:sessionId>2008081210584799</sear:sessionId> <sear:clientIP>127.0.0.1</sear:clientIP> </sear:searchLogging> <sear:maxResultsPerPage>10</sear:maxResultsPerPage> </ser:definedParameters> </ser:serviceParameters>
Output XML Example
This service will return a VoyagerServiceDataDocument containing a searchResultsType which contains the results of the course reserve browse.
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:searchResultsType" xmlns:sear="http://www.endinfosys.com/Voyager/search"> <sear:searchType>RESERVE_BROWSE</sear:searchType> <sear:reserveBrowseResults> <sear:reserveDepartments> <sear:reserveDepartment> <sear:departmentId>12</sear:departmentId> <sear:departmentName>Philosophy</sear:departmentName> <sear:departmentCode>66</sear:departmentCode> <sear:clusterId>1</sear:clusterId> <sear:courseId>35</sear:courseId> <sear:courseName>Photo Basics</sear:courseName> <sear:courseNumber>101</sear:courseNumber> <sear:sectionId>14</sear:sectionId> <sear:sectionNumber>Secti?</sear:sectionNumber> <sear:numberOfStudents>666</sear:numberOfStudents> <sear:instructorId>34</sear:instructorId> <sear:instructorLastName>Sellers</sear:instructorLastName> <sear:instructorFirstName>David</sear:instructorFirstName> <sear:instructorTitle>Mr.</sear:instructorTitle> </sear:reserveDepartment> </sear:reserveDepartments> </sear:reserveBrowseResults> </serviceData> </voyagerServiceData>