Record
General Purpose
This resource may be accessed with a GET method to retrieve a specific record from the server home of the record. The output may indicate if there are holdings or items under the record.
Optionally, if a patron is specified, it also displays whether certain requests such as a hold or call slip can be requested by the patron.
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 | Optional parameter indicates a 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 | No |
| patron_homedb | query parameter | Option parameter indicates a Voyager patron home DB key. This parameter is required if the patron is specified. | string | None | No |
| patron_group | query parameter | Optional parameter indicates the Voyager patron group ID. This parameter may be required if the patron is specified. If not specified, the server uses its best-guess patron group ID. | string | None | No |
| view=full | query parameter | Optional parameter indicates if entire MARC record should be returned. | string | None | No |
Input URL Syntax
The following is a URL to retrieve the record ID on the record home server:
http://10.100.2.37:30114/vxws/record/50000
The following is a URL to retrieve the record ID on the record home server with additional patron information:
http://10.100.2.37:30114/vxws/record/50000?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1
Output XML Format
The following is an output of record:
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<reply-text>ok</reply-text>
<reply-code>0</reply-code>
<record>
<info type="holdings" href="http://10.100.2.37:30114/vxws/record/50000/holdings" />
<info type="items" href="http://10.100.2.37:30114/vxws/record/50000/items" />
</record>
</response>
The following is output including additional patron information regarding whether a patron can perform a certain request:
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<reply-text>ok</reply-text>
<reply-code>0</reply-code>
<record>
<info type="holdings" href="http://10.100.2.37:30114/vxws/record/50000/holdings" />
<info type="items" href="http://10.100.2.37:30114/vxws/record/50000/items" />
<info type="Recall" href="http://10.100.2.37:30114/vxws/record/50000/recall?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="N">
<note type="error">The item is not charged.</note>
</info>
<info type="HoldRequest" href="http://10.100.2.37:30114/vxws/record/50000/hold?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" />
<info type="CallSlip" href="http://10.100.2.37:30114/vxws/record/50000/callslip?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" />
<info type="PatronRequests" href="http://10.100.2.37:30114/vxws/record/50000/patronrequests?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" />
</record>
</response>
With Voyager 9.1 and later, if the patron is not permitted to place any requests due to a block, the following will be included in the response:
<info type="norequests"> <note type="info">You have no available requests in this database.</note> </info>
Possible Error Codes
19: Record does not exist