Patron Requests Per Title
General Purpose
The title level request resource may be accessed with a GET method to retrieve a link to services that are not available via the VXWS. This returns a list of possible links. The patron is prompted to enter his/her logon information with the Voyager front end. The patron is then presented with the desired page.
This service only sends requests of types that have not already been provided by VXWS. That is, this service does not send information about requests of type Hold, Recall, Call Slip, or UB Request.
The link is supplied in the results as a fully formulated, functioning link.
The vwebv:port should be a customer-defined base URL configurable in the VXWS configuration file. If this is not supplied or is blank, the URI is not constructed.
The skin is a locally customized view of the Voyager OPAC. Voyager customers may want to choose a specific skin for the OPAC that is used for this purpose and is configured in the VXWS configuration file in Voyager. If this is not supplied or is blank, the parameter can be left off of the URI.
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 | |
| 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 URL Syntax
<Base URL>:/record/<record ID>/patronrequests?patron=patId&patron_homedb=homedb&patron_group=NN
Example
The following is a URL to retrieve a link to services for a patron’s requests that are not available via the VXWS:
http://10.100.2.37:30114/vxws/record/155/patronrequests?patron=185&patron_homedb=1@QA20012DB20020613131313&patron_group=1
Output XML Format
The following is an output of a patron’s requests that are not available via the VXWS:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <patron-requests> <all-requests> <site-id>1@QA20012DB20020613131313</site-id> <db-name>University Library</db-name> <link>http://10.100.2.37:30108/vwebv/patronRequests?sk=en_US&bibId=155&bibDbCode=&requestSiteId=1@QA20012DB20020613131313&bibDbName=University Library</link> </all-requests> <request> <code>ILLBL</code> <name>ILL Blank Request</name> <site-id>1@QA20012DB20020613131313</site-id> <db-name>University Library</db-name> <link>http://10.100.2.37:30108/vwebv/patronRequest?sk=en_US&bibId=155&bibDbCode=&requestCode=ILLBL&requestSiteId=1@QA20012DB20020613131313&bibDbName=University Library</link> </request> <request> <code>MEDIAEQUIP</code> <name>Media Equipment Booking</name> <site-id>1@QA20012DB20020613131313</site-id> <db-name>University Library</db-name> <link>http://10.100.2.37:30108/vwebv/patronRequest?sk=en_US&bibId=155&bibDbCode=&requestCode=MEDIAEQUIP&requestSiteId=1@QA20012DB20020613131313&bibDbName=University Library</link> </request> <request> <code>MARIEBIB</code> <name>Marie's super special bib level form</name> <site-id>1@QA20012DB20020613131313</site-id> <db-name>University Library</db-name> <link>http://10.100.2.37:30108/vwebv/patronRequest?sk=en_US&bibId=155&bibDbCode=&requestCode=MARIEBIB&requestSiteId=1@QA20012DB20020613131313&bibDbName=University Library</link> </request> </patron-requests> </response>
Possible Error Codes
51: patron_homedb is a required parameter