RelatedBibCountService

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

General Purpose

Retrieve the number of related bibs for a given bibliographic record id and set of profile codes.

Requirements

Voyager 7.x and higher.

Input URL Syntax

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

http://server:port/vxws/RelatedBibCountService

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 required parameter:

  • bibId – the id of the bib record.
  • profileCodes – an array of one or more profile codes.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
   <ser:parameters>
      <ser:parameter key="bibId">
         <ser:value>11652</ser:value>
      </ser:parameter>
      <ser:parameter key="profileCodes">
         <ser:value>ISSNCOMP</ser:value>
         <ser:value>ISSNSUCC</ser:value>
         <ser:value>ISSNPREC</ser:value>
      </ser:parameter>
   </ser:parameters>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument containing a relatedBibCounts element which contains a relatedBibCount element for each profile code.

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:relatedBibCountsType" xmlns:sear="http://www.endinfosys.com/Voyager/search">
    <sear:relatedBibCount>
      <sear:profileCode>ISSNCOMP</sear:profileCode>
      <sear:count>0</sear:count>
    </sear:relatedBibCount>
    <sear:relatedBibCount>
      <sear:profileCode>ISSNSUCC</sear:profileCode>
      <sear:count>0</sear:count>
    </sear:relatedBibCount>
    <sear:relatedBibCount>
      <sear:profileCode>ISSNPREC</sear:profileCode>
      <sear:count>0</sear:count>
    </sear:relatedBibCount>
  </serviceData>
</voyagerServiceData>