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
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 | Yes |
Input XML Elements
Parameter | Description | Value | Default | Required |
---|---|---|---|---|
<comment> | Comment from the patron regarding this request (maximum 100 characters) | string | None | No |
<dbkey> | Database keyof the requested item | string | None | Yes |
<pickup-location> | Copy for pickup location | integer | None | No |
Input URL Syntax
<Base URL>:/record/<record ID>/items/<item ID>/callslip?patron=patId&patron_homedb=homedb&patron_group=NN
Example
The following is an URL to access patron’s call slip request information for a specific item.
http://server:port/vxws/record/501/items/751/callslip?patron=185&patron_homedb=1@QA20012DB20020613131313&patron_group=1
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"?> <call-slip-parameters> <comment>testing callslip request</comment> <dbkey>1@QA20012DB20020613131313</dbkey> <pickup-location>13</pickup-location> <reqinput field="1">Volume</reqinput> <reqinput field="2">Issue</reqinput> <reqinput field="3">Year</reqinput> </call-slip-parameters>
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" ?> <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" /> </callslip> </response>
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"?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <create-call-slip> <note type="">Your request was successful.</note> </create-call-slip> </response>
Possible Error Codes
27: Item does not exist