BibsForHeadings

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

General Purpose

Displays the bib records that are in the heading.

Requirements

Voyager 7.x and higher

Input URL Syntax

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

http://server:port/vxws/SearchBibsForHeadingService

XSD

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

Input XML Example

This service expects to receive a ServiceParametersType document containing the following parameters:

  • resultPointer – a pointer into the result set of the previous search.
  • maxResultsPerPage – the maximum number of results to return.

Example:

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

Output XML Example

This service will return a VoyagerServiceDataDocument containing a searchResultsType element which contains the bibSearchResults for bib record linked to the given heading record from the most recent 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:searchResultsType" xmlns:sear="http://www.endinfosys.com/Voyager/search">
    <sear:totalHits>1</sear:totalHits>
    <sear:searchType>FIND</sear:searchType>
    <sear:bibSearchResults>
      <sear:headings>
        <sear:columnHeadings>
          <sear:columnHeading>
            <sear:headingName>title</sear:headingName>
            <sear:columnHeading>Title</sear:columnHeading>
          </sear:columnHeading>
          <sear:columnHeading>
            <sear:headingName>pub_dates_combined</sear:headingName>
            <sear:columnHeading>Dates</sear:columnHeading>
          </sear:columnHeading>
          <sear:columnHeading>
            <sear:headingName>author</sear:headingName>
            <sear:columnHeading>ÅåöÖÄä/Author</sear:columnHeading>
          </sear:columnHeading>
        </sear:columnHeadings>
        <sear:indexCode>S</sear:indexCode>
        <sear:name>OPAC Subject Headings Search</sear:name>
      </sear:headings>
      <sear:results>
        <sear:result>
          <sear:bibId>70885</sear:bibId>
          <sear:bibText1>Petr Velikij: pro et contra lic?nost' i dea^nia^ Petra I v ocenke russkih myslitelej i issledovatelej antologia^</sear:bibText1>
          <sear:bibText2>2001</sear:bibText2>
          <sear:bibText3/>
          <sear:callNumber/>
          <sear:mfhdCount>1</sear:mfhdCount>
          <sear:itemCount>1</sear:itemCount>
          <sear:itemStatusCode>1</sear:itemStatusCode>
          <sear:locationName>Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</sear:locationName>
          <sear:opacSuppressFlag>N</sear:opacSuppressFlag>
          <sear:relevanceRanking xsi:nil="true"/>
          <sear:headingText>Petr I car'</sear:headingText>
          <sear:headingType xsi:nil="true"/>
          <sear:indexCode xsi:nil="true"/>
          <sear:databaseCode xsi:nil="true"/>
          <sear:elink xsi:nil="true"/>
          <sear:elinkType xsi:nil="true"/>
        </sear:result>
      </sear:results>
    </sear:bibSearchResults>
  </serviceData>
</voyagerServiceData>