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
Parameter | Type | Description | Value | Default | Required |
---|---|---|---|---|---|
record ID | path parameter | The Voyager bibliographic record ID | string | None | Yes |
item ID | path parameter | The Voyager item record identifier. | 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 |
<last-interest-date> | The latest date in which the item must be supplied in yyyymmdd format | string | None | Yes |
<pickup-location> | The code of the requested pickup location, for example 12 | string | None | Yes |
Input URL Syntax
<Base URL>:/record/<record ID>/items/<item ID>/hold?patron=patId&patron_homedb=homedb&patron_group=NN
Example
The following is a URL to access a patron’s hold request information for a specific item:
href="http://10.100.2.37:30114/vxws/record/155/items/303/hold?patron=185&patron_homedb=1@QA20012DB20020613131313&patron_group=1"
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"?> <hold-request-parameters> <pickup-location>13</pickup-location> <last-interest-date>20091019</last-interest-date> <comment>testing hold request</comment> <dbkey>1@QA20012DB20020613131313</dbkey> </hold-request-parameters>
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" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <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> </pickup-locations> <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" /> </hold> </response>
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"?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <create-hold> <note type="">Your request was successful.</note> </create-hold> </response>
Possible Error Codes
27: Item does not exist