Record Items
General Purpose
This resource may be accessed with a GET method to retrieve items information for a specific bibliographic 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 |
item ID | path parameter | When it is specified, all pertinent item data for the specific item is returned. | string | None | No |
view | query parameter | If view=brief, a set of common item data such as location or status is displayed. If view=full, all pertinent item data is displayed. | string | None | No |
patron | query parameter | The Voyager patron system ID | string | None | No |
patron_homedb | query parameter | The patron home DB key. It is required if patron is specified. | string | None | No |
patron_group | query parameter | The patron group ID. It is optional. If it is not specified, the server attempts to pick the best-guess group ID for the patron. | string | None | No |
location | query parameter | Location code of the item such as biology. The code is defined in the SysAdmin -> Systems -> Locations. The location parameter may be used to filter the items list of only the items of one location. Only items whose temporary location code or permanent location code matches the input is reported. NOTE: The temporary location code overrides the permanent location code. If there is a temporary location code, do not check the permanent location code. | string | None | No |
year | query parameter | The year parameter may be used to filter the items list to display only the items of one year. Only items with the year field that matches the input are reported. | string | None | No |
loaned | query parameter | A “Y” value indicates that only charged items are listed. A “N” value indicates that only not charged items are listed. | string | None | No |
lang | query parameter | Three-letter ISO code for a language. It specifies the location of the vxws.properties file in yyydb/tomcat/vxws/context/vxws/ui/lang. vxws.properties is a customizable properties file initially constructed from the same values in the existing WEBV properties file in which a customer may modify text regarding patron status, request status, and renewal status, for example. | string | eng | No |
Input URL Syntax
The following is an example of a URL to retrieve the item data for a specific bibliographic record ID:
http://server:port/vxws/record/50000/items
The following is an example of a URL to retrieve the full item data for a specific bibliographic record ID:
http://server:port/vxws/record/50000/items?view=full
The following is an example of a URL to retrieve specific item data for a specific bibliographic record ID:
http://server:port/vxws/record/50000/items?view=full
The following is an example of a URL to retrieve specific location item data for a specific bibliographic record ID:
The brief option is for illustrating the output having the matching data. It does not need to be entered.
http://server:port/vxws/record/50000/items?view=brief&location=biology
The following is an example of a URL to retrieve specific year item data for a specific bibliographic record ID:
The brief option is for illustrating the output having the matching data. It does not need to be entered.
http://server:port/vxws/record/50000/items?view=brief&year=2009
The following is an example of URL to retrieve a list of charged item data for a specific bibliographic record ID:
The brief option is for illustrating the output having the matching data. It does not need to be entered.
http://server:port/vxws/record/50000/items?view=brief&loaned=Y
The following is an example of a URL to retrieve a list of not charged item data for a specific bibliographic record ID:
The brief option is for illustrating the output having the matching data. It does not need to be entered.
http://server:port/vxws/record/50000/items?view=brief&loaned=N
The following is an example of a URL to retrieve a list of items for a specific bibliographic record ID:
In addition, it also indicates whether a patron is allowed to make the request for a specific item.
http://server:port/vxws/record/10000/items?patron_homedb=1@QA20012DB20020613131313&patron=1000007&patron_group=1
Output XML Format
The following is an example of output of retrieving the item data for a specific bibliographic record ID:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <items> <institution id="LOCAL"> <instName>University Library</instName> <item href="http://10.100.2.37:30114/vxws/record/50000/items/56595" /> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72730" /> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72731" /> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72732" /> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72733" /> </institution> </items> </response>
The following is an example of output of retrieving the brief item data for a specific bibliographic record ID:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <items> <institution id="LOCAL"> <instName>University Library</instName> <item href="http://10.100.2.37:30114/vxws/record/50000/items/56595"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">220.7 B58ma1</itemData> <itemData name="copy">0</itemData> <itemData name="itemBarcode">50755</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72730"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">220.7 B58ma1</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">50000508281</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72731"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">a456</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">50000693711</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72732"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">a789 b123</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">50000693721</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72733"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">a789 b123</itemData> <itemData name="copy">4</itemData> <itemData name="itemBarcode">50000693722</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> </institution> </items> </response>
The following is an example of output of retrieving the full item data for a specific bibliographic record ID:
<?xml version="1.0" encoding="UTF8" ?> <response> <replytext>ok</replytext> <replycode>0</replycode> <items> <institution id="LOCAL"> <instName>University Library</instName> <item href="http://10.100.2.37:30114/vxws/record/50000/items/56595"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">220.7 B58ma1</itemData> <itemData name="copy">0</itemData> <itemData name="itemBarcode">50755</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="caption" /> <itemData name="freeText" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="tempDesc" /> <itemData name="mediaType">0</itemData> <itemData name="mediadesc" /> <itemData name="itemStatus">Not Charged</itemData> <itemData name="pieceCount">1</itemData> <itemData name="amount">0.00</itemData> <itemData name="spineLabel" /> <itemData name="historicalCharges">0</itemData> <itemData name="historicalBrowses">0</itemData> <itemData name="historicalBookings">0</itemData> <itemData name="recallsPlaced">0</itemData> <itemData name="holdsPlaced">0</itemData> <itemData name="itemNote">0</itemData> <itemData name="reserveCharges">0</itemData> <itemData name="onReserve">N</itemData> <itemData name="shortLoanChgs">0</itemData> <itemData name="createDate" /> <itemData name="createOperId" /> <itemData name="createLocation" /> <itemData name="modifyDate">19970116</itemData> <itemData name="modifyOperId" /> <itemData name="modifyLocation" /> <itemData name="lastTrans" /> <itemData name="clusterId">1</itemData> <itemData name="bibId">50000</itemData> <itemData name="libraryId">1</itemData> <itemData name="historicalReserveCharges">0</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72730"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">220.7 B58ma1</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">50000508281</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="caption" /> <itemData name="freeText" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="tempDesc" /> <itemData name="mediaType">0</itemData> <itemData name="mediadesc" /> <itemData name="itemStatus">Not Charged</itemData> <itemData name="pieceCount">1</itemData> <itemData name="amount">0.00</itemData> <itemData name="spineLabel" /> <itemData name="historicalCharges">1</itemData> <itemData name="historicalBrowses">0</itemData> <itemData name="historicalBookings">0</itemData> <itemData name="recallsPlaced">0</itemData> <itemData name="holdsPlaced">0</itemData> <itemData name="itemNote">0</itemData> <itemData name="reserveCharges">0</itemData> <itemData name="onReserve">N</itemData> <itemData name="shortLoanChgs">0</itemData> <itemData name="createDate">20080911</itemData> <itemData name="createOperId">demo</itemData> <itemData name="createLocation">Cataloging Desk</itemData> <itemData name="modifyDate" /> <itemData name="modifyOperId" /> <itemData name="modifyLocation" /> <itemData name="lastTrans">20080930 08:53:22</itemData> <itemData name="clusterId">1</itemData> <itemData name="bibId">50000</itemData> <itemData name="libraryId">1</itemData> <itemData name="historicalReserveCharges">0</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72731"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">a456</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">50000693711</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="caption" /> <itemData name="freeText" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="tempDesc" /> <itemData name="mediaType">0</itemData> <itemData name="mediadesc" /> <itemData name="itemStatus">Not Charged</itemData> <itemData name="pieceCount">1</itemData> <itemData name="amount">0.00</itemData> <itemData name="spineLabel" /> <itemData name="historicalCharges">0</itemData> <itemData name="historicalBrowses">0</itemData> <itemData name="historicalBookings">0</itemData> <itemData name="recallsPlaced">0</itemData> <itemData name="holdsPlaced">0</itemData> <itemData name="itemNote">0</itemData> <itemData name="reserveCharges">0</itemData> <itemData name="onReserve">N</itemData> <itemData name="shortLoanChgs">0</itemData> <itemData name="createDate">20080916</itemData> <itemData name="createOperId">demo</itemData> <itemData name="createLocation">Cataloging Desk</itemData> <itemData name="modifyDate" /> <itemData name="modifyOperId" /> <itemData name="modifyLocation" /> <itemData name="lastTrans" /> <itemData name="clusterId">1</itemData> <itemData name="bibId">50000</itemData> <itemData name="libraryId">1</itemData> <itemData name="historicalReserveCharges">0</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72732"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">a789 b123</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">50000693721</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="caption" /> <itemData name="freeText" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="tempDesc" /> <itemData name="mediaType">0</itemData> <itemData name="mediadesc" /> <itemData name="itemStatus">Not Charged</itemData> <itemData name="pieceCount">1</itemData> <itemData name="amount">0.00</itemData> <itemData name="spineLabel" /> <itemData name="historicalCharges">0</itemData> <itemData name="historicalBrowses">0</itemData> <itemData name="historicalBookings">0</itemData> <itemData name="recallsPlaced">0</itemData> <itemData name="holdsPlaced">0</itemData> <itemData name="itemNote">0</itemData> <itemData name="reserveCharges">0</itemData> <itemData name="onReserve">N</itemData> <itemData name="shortLoanChgs">0</itemData> <itemData name="createDate">20080916</itemData> <itemData name="createOperId">demo</itemData> <itemData name="createLocation">Cataloging Desk</itemData> <itemData name="modifyDate" /> <itemData name="modifyOperId" /> <itemData name="modifyLocation" /> <itemData name="lastTrans" /> <itemData name="clusterId">1</itemData> <itemData name="bibId">50000</itemData> <itemData name="libraryId">1</itemData> <itemData name="historicalReserveCharges">0</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/50000/items/72733"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">a789 b123</itemData> <itemData name="copy">4</itemData> <itemData name="itemBarcode">50000693722</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="caption" /> <itemData name="freeText" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="tempDesc" /> <itemData name="mediaType">0</itemData> <itemData name="mediadesc" /> <itemData name="itemStatus">Not Charged</itemData> <itemData name="pieceCount">1</itemData> <itemData name="amount">0.00</itemData> <itemData name="spineLabel" /> <itemData name="historicalCharges">0</itemData> <itemData name="historicalBrowses">0</itemData> <itemData name="historicalBookings">0</itemData> <itemData name="recallsPlaced">0</itemData> <itemData name="holdsPlaced">0</itemData> <itemData name="itemNote">0</itemData> <itemData name="reserveCharges">0</itemData> <itemData name="onReserve">N</itemData> <itemData name="shortLoanChgs">0</itemData> <itemData name="createDate">20080916</itemData> <itemData name="createOperId">demo</itemData> <itemData name="createLocation">Cataloging Desk</itemData> <itemData name="modifyDate" /> <itemData name="modifyOperId" /> <itemData name="modifyLocation" /> <itemData name="lastTrans" /> <itemData name="clusterId">1</itemData> <itemData name="bibId">50000</itemData> <itemData name="libraryId">1</itemData> <itemData name="historicalReserveCharges">0</itemData> </item> </institution> </items> </response>
The following is an example of output of retrieving specific item data for a specific bibliographic record ID:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <item> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">220.7 B58ma1</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">50000508281</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="caption" /> <itemData name="freeText" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="tempDesc" /> <itemData name="mediaType">0</itemData> <itemData name="mediadesc" /> <itemData name="itemStatus">Not Charged</itemData> <itemData name="pieceCount">1</itemData> <itemData name="amount">0.00</itemData> <itemData name="spineLabel" /> <itemData name="historicalCharges">1</itemData> <itemData name="historicalBrowses">0</itemData> <itemData name="historicalBookings">0</itemData> <itemData name="recallsPlaced">0</itemData> <itemData name="holdsPlaced">0</itemData> <itemData name="itemNote">0</itemData> <itemData name="reserveCharges">0</itemData> <itemData name="onReserve">N</itemData> <itemData name="shortLoanChgs">0</itemData> <itemData name="createDate">2008-09-11</itemData> <itemData name="createOperId">demo</itemData> <itemData name="createLocation">Cataloging Desk</itemData> <itemData name="modifyDate" /> <itemData name="modifyOperId" /> <itemData name="modifyLocation" /> <itemData name="lastTrans">2008-09-30 08:53:22</itemData> <itemData name="clusterId">1</itemData> <itemData name="bibId">50000</itemData> <itemData name="libraryId">1</itemData> <itemData name="historicalReserveCharges">0</itemData> </item> </response>
The following is an example of output of retrieving item data at a specific location for a specific bibliographic record ID:
This output is with the view=brief option to show the location that matches the input.
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <items> <institution id="LOCAL"> <instName>University Library</instName> <item href="http://10.100.2.37:30114/vxws/record/10000/items/73025"> <itemData id="1" name="permLocation" code="reference">Reference Department</itemData> <itemData id="3" name="tempLocation" code="biology">Biology</itemData> <itemData id="1" name="location" code="reference">Reference Department</itemData> <itemData name="callNumber">456</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">100006957401</itemData> <itemData name="enumeration">1</itemData> <itemData name="chron" /> <itemData name="year">2009</itemData> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> </institution> </items> </response>
The following is an example of output of retrieving item data in a specific year for a specific bibliographic record ID:
This output is with the view=brief option to show the location that matches the input.
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <items> <institution id="LOCAL"> <instName>University Library</instName> <item href="http://10.100.2.37:30114/vxws/record/10000/items/73025"> <itemData id="1" name="permLocation" code="reference">Reference Department</itemData> <itemData id="3" name="tempLocation" code="biology">Biology</itemData> <itemData id="1" name="location" code="reference">Reference Department</itemData> <itemData name="callNumber">456</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">100006957401</itemData> <itemData name="enumeration">1</itemData> <itemData name="chron" /> <itemData name="year">2009</itemData> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> </institution> </items> </response>
The following output example displays a list of charged items with loaned=Y as the input and view=brief:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <items> <institution id="LOCAL"> <instName>University Library</instName> <item href="http://10.100.2.37:30114/vxws/record/10000/items/73025"> <itemData id="1" name="permLocation" code="reference">Reference Department</itemData> <itemData id="3" name="tempLocation" code="biology">Biology</itemData> <itemData id="1" name="location" code="reference">Reference Department</itemData> <itemData name="callNumber">456</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">100006957401</itemData> <itemData name="enumeration">1</itemData> <itemData name="chron" /> <itemData name="year">2009</itemData> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> </institution> </items> </response>
The following output example displays a list of not charged items with loaned=N as input and view=brief:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <items> <institution id="LOCAL"> <instName>University Library</instName> <item href="http://10.100.2.37:30114/vxws/record/10000/items/10923"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">ML410.S6872 Z2</itemData> <itemData name="copy">0</itemData> <itemData name="itemBarcode">52038</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> <item href="http://10.100.2.37:30114/vxws/record/10000/items/72800"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">ML410.S6872 Z2</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">1000010252</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> </item> </institution> </items> </response>
The following is an example of output of items from a specific bibliographic record:
In addition, it displays whether a patron is allowed to request specific items.
NOTE: Item ID 73025 is charged, there is no hold, recall, or call slip requests for that item. The view=brief option is used to generate the output to show item status.
<?xml version="1.0" encoding="UTF8" ?> <response> <replytext>ok</replytext> <replycode>0</replycode> <items> <institution id="LOCAL"> <instName>University Library</instName> <item href="http://10.100.2.37:30114/vxws/record/10000/items/10923"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">ML410.S6872 Z2</itemData> <itemData name="copy">0</itemData> <itemData name="itemBarcode">52038</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> <info type="Recall" href="http://10.100.2.37:30114/vxws/record/10000/items/10923/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/10000/items/10923/hold?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" /> <info type="CallSlip" href="http://10.100.2.37:30114/vxws/record/10000/items/10923/callslip?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" /> <info type="PatronRequests" href="http://10.100.2.37:30114/vxws/record/10000/items/10923/patronrequests?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" /> </item> <item href="http://10.100.2.37:30114/vxws/record/10000/items/72800"> <itemData id="8" name="permLocation" code="main">Main Stacks</itemData> <itemData id="0" name="tempLocation" /> <itemData id="8" name="location" code="main">Main Stacks</itemData> <itemData name="callNumber">ML410.S6872 Z2</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">1000010252</itemData> <itemData name="enumeration" /> <itemData name="chron" /> <itemData name="year" /> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Not Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> <info type="Recall" href="http://10.100.2.37:30114/vxws/record/10000/items/72800/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/10000/items/72800/hold?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" /> <info type="CallSlip" href="http://10.100.2.37:30114/vxws/record/10000/items/72800/callslip?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" /> <info type="PatronRequests" href="http://10.100.2.37:30114/vxws/record/10000/items/72800/patronrequests?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="Y" /> </item> <item href="http://10.100.2.37:30114/vxws/record/10000/items/73025"> <itemData id="1" name="permLocation" code="reference">Reference Department</itemData> <itemData id="3" name="tempLocation" code="biology">Biology</itemData> <itemData id="1" name="location" code="reference">Reference Department</itemData> <itemData name="callNumber">456</itemData> <itemData name="copy">1</itemData> <itemData name="itemBarcode">100006957401</itemData> <itemData name="enumeration">1</itemData> <itemData name="chron" /> <itemData name="year">2009</itemData> <itemData name="typeCode">1</itemData> <itemData name="typeDesc">Book</itemData> <itemData name="tempType">0</itemData> <itemData name="itemStatus">Charged</itemData> <itemData name="itemNote">0</itemData> <itemData name="onReserve">N</itemData> <info type="Recall" href="http://10.100.2.37:30114/vxws/record/10000/items/73025/recall?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="N"> <note type="error">No recall policy is defined for this item.</note> </info> <info type="HoldRequest" href="http://10.100.2.37:30114/vxws/record/10000/items/73025/hold?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="N"> <note type="error">No hold policy is defined for this item.</note> </info> <info type="CallSlip" href="http://10.100.2.37:30114/vxws/record/10000/items/73025/callslip?patron=1000007&patron_homedb=1@QA20012DB20020613131313&patron_group=1" allowed="N"> <note type="error">No items are available for CallSlip requests.</note> </info> </item> </institution> </items> </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
27: Item does not exist