UBHoldingsLibService

General Purpose

Retrieves a list of available copies, pick up libraries and pick up locations for a given bibliographic record at a given UB holdings library.

Requirements

Voyager 7.x and higher.

Input URL Syntax

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

http://server:port/vxws/UBHoldingsLibService

Input XML Example

This service expects to receive a ServiceParametersDocument containing a patronIdentifier and the following required parameters:

  • holdingsLibId – the id of the holdings library for which copies, libraries and pick up locations are desired.
  • bibId – the bibliographic record id of the item being requested.

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>43508</ser:value>
    </ser:parameter>
    <ser:parameter key="holdingsLibId">
      <ser:value>1@GWCCDB20010402131061</ser:value>
    </ser:parameter>
  </ser:parameters>
  <ser:patronIdentifier lastName="duong" patronHomeUbId="1@DMADB20010103091142" patronId="204">
    <ser:authFactor type="B">duong5678</ser:authFactor>
  </ser:patronIdentifier>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument containing a requestsCollectionType element containing a requestDefinition element containing a copies element, a pickUpLibraries element and a pickUpLocations element. See the VoyagerRequestsSchema for more details on the contents of these elements.

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="req:requestsCollectionType" xmlns:req="http://www.endinfosys.com/Voyager/requests">
    <req:requestDefinition>
      <req:requestIdentifier requestCode="UB" requestName="UB_Request" requestType="S"/>
      <req:copies>
        <req:copy id="17529.16764">v.18 31004000238670 DWC-Stacks (UBGWCC70DB)</req:copy>
        <req:copy id="17530.16764">v.25 31004000238688 DWC-Stacks (UBGWCC70DB)</req:copy>
      </req:copies>
      <req:pickUpLibraries>
        <req:location id="1@DMADB20010103091142" isDefault="Y">UBDMA70DB</req:location>
        <req:location id="1@RSCCDB20010402160646">UBRSCC70DB</req:location>
      </req:pickUpLibraries>
      <req:pickUpLocations>
        <req:location id="10" isDefault="Y">Circulation Desk</req:location>
        <req:location id="5">Reves Collection</req:location>
      </req:pickUpLocations>
    </req:requestDefinition>
  </serviceData>
</voyagerServiceData>