PatronRequests

General Purpose

Return a list of available requests for a given patron to make for the specified bib.

Requirements

Voyager 7.x and higher.

Input URL Syntax

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

http://server:port/vxws/PatronRequestsService

Input XML Example

This service expects to receive a ServiceParametersDocument containing a patronIdentifier and the following ‘optional’ parameter is required if available:

  • bibId – the bibliographic record id of the item being requested.
  • bibDbCode – holding library of the bibId.

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>35001628</ser:value>
    </ser:parameter>
    <ser:parameter key="bibDbCode">
      <ser:value>KC70DB</ser:value>
    </ser:parameter>
  </ser:parameters>
  <ser:patronIdentifier lastName="Duong" patronHomeUbId="1@QA20012DB20020613131313" patronId="1000007">
    <ser:authFactor type="B">duong1234</ser:authFactor>
  </ser:patronIdentifier>
</ser:serviceParameters>

Output XML Example

This service will return a VoyagerServiceDataDocument containing a requestCollection element containing an available element which contains a list of requestIdentifier elements for each of the requests available to the given patron. PatronRequestService may also return a messages element containing a patron block message if the patron is blocked from making the given request.

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:availableRequests>
      <req:requestIdentifier requestCode="NOBIBDAT" requestName="Blank Form" requestType="0" libraryName="" requestSiteId="1@QA20012DB20020613131313">Blank Form</req:requestIdentifier>
      <req:requestIdentifier requestCode="MEDIAEQUIP" requestName="Media Equipment Booking" requestType="S" libraryName="C1 for dev70 on KC" requestSiteId="1@WHOIDB200501002112461">Media Equipment Booking</req:requestIdentifier>
      <req:requestIdentifier requestCode="ILLBL" requestName="ILL Blank Request" requestType="E" libraryName="" requestSiteId="1@QA20012DB20020613131313">ILL Blank Request</req:requestIdentifier>
      <req:requestIdentifier requestCode="BIBLEVEL" requestName="BibLevel" requestType="B" libraryName="" requestSiteId="1@QA20012DB20020613131313">BibLevel</req:requestIdentifier>
      <req:requestIdentifier requestCode="ILLBLANKPH" requestName="ILL Blank Photo Request" requestType="F" libraryName="" requestSiteId="1@QA20012DB20020613131313">ILL Blank Photo Request</req:requestIdentifier>
      <req:requestIdentifier requestCode="ARTEPHOTO" requestName="ARTEmail Photocopy Form" requestType="P" libraryName="" requestSiteId="1@QA20012DB20020613131313">ARTEmail Photocopy Form</req:requestIdentifier>
      <req:requestIdentifier requestCode="ARTEMAIL" requestName="ARTEmail Loan Form" requestType="L" libraryName="" requestSiteId="1@QA20012DB20020613131313">ARTEmail Loan Form</req:requestIdentifier>
    </req:availableRequests>
  </serviceData>
</voyagerServiceData>