Call Slip Per Item

General Purpose

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

The resource may be accessed with a PUT method to create a call slip 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
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.stringNoneYes

Input XML Elements

<comment>Comment from the patron regarding this request (maximum 100 characters)stringNoneNo
<dbkey>Database keyof the requested itemstringNoneYes
<pickup-location>Copy for pickup locationintegerNoneNo

Input URL Syntax

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


The following is an URL to access patron’s call slip request information for a specific item.


To create a new item-level call slip 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 callslip request</comment>
   <reqinput field="1">Volume</reqinput>
   <reqinput field="2">Issue</reqinput>
   <reqinput field="3">Year</reqinput>

Output XML Format

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

<?xml version="1.0" encoding="UTF-8" ?>
  <callslip allowed="Y">
     <dbkey code="1@QA20012DB20020613131313" usage="Mandatory">University Library</dbkey>
     <instructions usage="read-only" />
     <comment max_len="100" usage="Optional" />

The following is an output of patron’s callslip 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