Hold Per Item

General Purpose

The resource may be accessed with a GET method to retrieve a specific patron’s hold request information for a specific item.

The resource may be accessed with a PUT method to create a hold request for a specific patron and on a specific item.

Product Version Compatibility

Voyager 7.2.0 and later.

Input Parameters

record IDpath parameterThe Voyager bibliographic record IDstringNoneYes
item IDpath parameterThe Voyager item record identifier.stringNoneYes
patronquery parameterThe Voyager patron system ID. The system ID can be retrieved from the Voyager circulation staff client interface or returned from the AuthenticatePatronService Web service with patron barcode and last name. The purpose of this parameter is to retrieve additional information regarding whether this patron can request the specific record.stringNoneYes
patron_homedbquery parameterThe Voyager patron home DB key.stringNoneYes
patron_groupquery parameterThis indicates the Voyager patron group ID. If this parameter is not specified, the server uses its best-guess patron group ID.stringNoneNo

Input XML Elements

<comment>Comment from the patron regarding this request (maximum 100 characters)stringNoneNo
<dbkey>Database key of the requested itemstringNoneYes
<last-interest-date>The latest date in which the item must be supplied in yyyymmdd formatstringNoneYes
<pickup-location>The code of the requested pickup location, for example 12stringNoneYes

Input URL Syntax

<Base URL>:/record/<record ID>/items/<item ID>/hold?patron=patId&patron_homedb=homedb&patron_group=NN


The following is a URL to access a patron’s hold request information for a specific item:


To create a new item-level hold request, use the same URL with a PUT method. The PUT XML must have the following structure:

<?xml version="1.0" encoding="UTF-8"?>
   <comment>testing hold request</comment>

Output XML Format

The following is an output of a patron’s hold request information for a specific item:

<?xml version="1.0" encoding="UTF-8" ?>
  <hold allowed="Y">
    <pickup-locations usage="Mandatory">
      <pickup-location code="13" default="N">Acquisitions</pickup-location>
      <pickup-location code="28" default="N">Branch General</pickup-location>
      <pickup-location code="11" default="N">Cataloging Desk</pickup-location>
      <pickup-location code="12" default="Y">Circulation Desk</pickup-location>
      <pickup-location code="45" default="N">DLC Test</pickup-location>
      <pickup-location code="8" default="N">Main Stacks</pickup-location>
      <pickup-location code="4" default="N">Media Department</pickup-location>
      <pickup-location code="17" default="N">Media Stacks</pickup-location>
      <pickup-location code="16" default="N">Offsite</pickup-location>
      <pickup-location code="31" default="N">Other Branch Circ. Desk</pickup-location>
      <pickup-location code="49" default="N">QA ILL Test</pickup-location>
      <pickup-location code="14" default="N">Reserve Desk</pickup-location>
    <dbkey code="1@QA20012DB20020613131313" usage="Mandatory">University Library</dbkey>
    <instructions usage="read-only">Please select an item. (FROM SysAdmin)</instructions>
    <last-interest-date usage="Mandatory">2010-01-07</last-interest-date>
    <comment max_len="100" usage="Optional" />

The following is an output of patron’s hold request for a specific item using the PUT method.

<?xml version="1.0" encoding="UTF-8"?>
           <note type="">Your request was successful.</note>

Possible Error Codes

27: Item does not exist