UBPickupLibService

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

General Purpose

Retrieves a list of available pick up locations for a given pick up library 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/UBPickupLibService

XSD

Click here to view the ServiceParametersSchema
Click here to view the VoyagerXmlSchema
Click here to view the ServiceDataSchema
Click here to view the VoyagerRequestsSchema

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 pick up locations are desired.
  • pickupLibId – the id of the pickup library at the holdings library for which pick up locations are desired.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
  <ser:parameters>
    <ser:parameter key="pickupLibId">
      <ser:value>1@GWCCDB20010402131061</ser:value>
    </ser:parameter>
  </ser:parameters>
  <ser:patronIdentifier lastName="Patel" patronHomeUbId="1@DMADB20010103091142" patronId="212">
    <ser:authFactor type="I">151</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 pickUpLocations element. See the VoyagerRequestsSchema for more details on the contents of those 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:pickUpLocations>
        <req:location id="16" isDefault="Y">DWC-Res</req:location>
        <req:location id="19">GWCC Circulation Desk</req:location>
      </req:pickUpLocations>
    </req:requestDefinition>
  </serviceData>
</voyagerServiceData>