Call Slip Per Title

Ex Libris Developer Network Voyager Documentation Voyager APIs RESTful Web Services Call Slip Per Title

General Purpose

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

The resource may be accessed with a PUT method to create a call slip request for a specific patron and on a specific title.

Product Version Compatibility

Voyager 7.2.0 and later.

Input Parameters

Parameter	Type	Description	Value	Default	Required
record ID	path parameter	The Voyager bibliographic record ID	string	None	Yes
patron	query parameter	The 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.	string	None	Yes
patron_homedb	query parameter	The Voyager patron home DB key.	string	None	Yes
patron_group	query parameter	This indicates the Voyager patron group ID. If this parameter is not specified, the server uses its best-guess patron group ID.	string	None	No

Input XML Elements

Parameter	Description	Value	Default	Required
<comment>	Comment from the patron regarding this request (maximum 100 characters)	string	None	No
<dbkey>	Database key of the requested item	string	None	Yes
<reqinput field=”1″>	User input for the first field, often Volume. Whether it is Optional or Mandatory is specified in the GetServices response.	string	None	user-defined
<reqinput field=”2″>	User input for second field, often Issue. Whether it is Optional or Mandatory is specified in the GetServices response.	string	None	user-defined
<reqinput field=”3″>	User input third field, often Year. Whether it is Optional or Mandatory is specified in the GetServices response.	string	None	user-defined
<mfhdid>	The first MFHD ID (holding record ID) for the bib record. Must be sent for itemless/title level call slip requests	string	None	Yes

Input URL Syntax

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

Example

The following is a URL to access a patron’s call slip request information.

http://server:port/vxws/record/501/callslip?patron=185&patron_homedb=1@QA20012DB20020613131313&patron_group=1

To create a new title-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"?>
<call-slip-title-parameters xmlns:ilsg="http://www.exlibris.com/primo/xsd/ilsg">
   <comment/>
   <dbkey>1@QA20012DB20020613131313</dbkey>
   <reqinput field="1">Volume</reqinput>
   <reqinput field="2">Issue</reqinput>
   <reqinput field="3">Year</reqinput>
   <mfhdId>522</mfhdId>
</call-slip-title-parameters>

Output XML Format

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

<?xml version="1.0" encoding="UTF-8" ?>
 <response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
 <callslip allowed="Y">
  <dbkey code="1@QA20012DB20020613131313" usage="Mandatory">University Library</dbkey>
  <instructions usage="read-only" />
  <comment max_len="100" usage="Optional" />
 <items usage="Mandatory">
 <no-item>
  <record_id>501</record_id>
  <reqinput field="item_enum" usage="Optional" max_len="80" />
  <reqinput field="item_chron" usage="Optional" max_len="80" />
  <reqinput field="item_year" usage="Optional" max_len="20" />
  <mfhdid usage="Mandatory">522</mfhdid>
  </no-item>
 <item>
  <item_id>751</item_id>
  <description>c.0 48582 Main Stacks</description>
  </item>
 <item>
  <item_id>73018</item_id>
  <description>c.0 50169568 Reference Department</description>
  </item>
  </items>
  </callslip>
  </response>

The following is an output of patron’s callslip request using the PUT method.

<?xml version="1.0" encoding="UTF-8"?>
 <response>
   <reply-text>ok</reply-text>
   <reply-code>0</reply-code>
   <create-call-slip-title>
      <note type="">Your request was successful.</note>
   </create-call-slip-title>
 </response>

Possible Error Codes

19: Record does not exist