Basic Item
General Purpose
This resource may be accessed with a GET method to retrieve items information for a specific item record.
Product Version Compatibility
Voyager 8.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 ID | string | None | |
| 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 | Yes |
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/item/72733
The following is an example of a URL to retrieve the brief item data for a specific bibliographic record ID:
http://server:port/vxws/item/72733?view=brief
The following is an example of a URL to retrieve the full item data for a specific bibliographic record ID:
http://server:port/vxws/item/72733?view=full
Output XML Format
The following is an example of output of retrieving the item data for a specific item ID:
default view=full
<?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">Medical Lib:Main Collection</itemData>
<itemData id="0" name="tempLocation"/>
<itemData id="8" name="location" code="main">Medical Lib:Main Collection</itemData>
<itemData name="callNumber">a789 b123</itemData>
<itemData name="copy">c. 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="itemStatusCode">1</itemData>
<itemData name="itemDueDate"/>
<itemData name="itemStatusDate">2010-10-10 17:41:54</itemData>
<itemData name="todayDate">2012-03-12 12:51:40</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-16</itemData>
<itemData name="createOperId">demo</itemData>
<itemData name="createLocation">Cataloging Desk</itemData>
<itemData name="modifyDate"/>
<itemData name="modifyOperId"/>
<itemData name="modifyLocation"/>
<itemData name="lastTrans">2010-10-07 17:41:53</itemData>
<itemData name="clusterId">1</itemData>
<itemData name="bibId">50000</itemData>
<itemData name="libraryId">1</itemData>
<itemData name="historicalReserveCharges">0</itemData>
<itemData name="holdLocation"/>
<itemData name="patronGroupCode"/>
<itemData name="lastName"/>
<itemData name="firstName"/>
</item>
</response>
The following is an example of output of retrieving the brief item data for a specific item 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">Medical Lib:Main Collection</itemData>
<itemData id="0" name="tempLocation"/>
<itemData id="8" name="location" code="main">Medical Lib:Main Collection</itemData>
<itemData name="callNumber">a789 b123</itemData>
<itemData name="copy">c. 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="itemStatus">Not Charged</itemData>
<itemData name="spineLabel"/>
<itemData name="itemNote">0</itemData>
<itemData name="onReserve">N</itemData>
</item>
</response>The following is an example of output of retrieving the full item data for a specific item 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">Medical Lib:Main Collection</itemData>
<itemData id="0" name="tempLocation"/>
<itemData id="8" name="location" code="main">Medical Lib:Main Collection</itemData>
<itemData name="callNumber">a789 b123</itemData>
<itemData name="copy">c. 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="itemStatusCode">1</itemData>
<itemData name="itemDueDate"/>
<itemData name="itemStatusDate">2010-10-10 17:41:54</itemData>
<itemData name="todayDate">2012-03-12 12:55:32</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-16</itemData>
<itemData name="createOperId">demo</itemData>
<itemData name="createLocation">Cataloging Desk</itemData>
<itemData name="modifyDate"/>
<itemData name="modifyOperId"/>
<itemData name="modifyLocation"/>
<itemData name="lastTrans">2010-10-07 17:41:53</itemData>
<itemData name="clusterId">1</itemData>
<itemData name="bibId">50000</itemData>
<itemData name="libraryId">1</itemData>
<itemData name="historicalReserveCharges">0</itemData>
<itemData name="holdLocation"/>
<itemData name="patronGroupCode"/>
<itemData name="lastName"/>
<itemData name="firstName"/>
</item>
</response>The following is an example of output of retrieving specific item data for a specific Item ID which also show all bibs attached:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<reply-text>ok</reply-text>
<reply-code>0</reply-code>
<item>
<itemData id="11" name="permLocation" code="CAT">Cataloging</itemData>
<itemData id="0" name="tempLocation"/>
<itemData id="3" name="location" code="biology">Reference Biology Stacks (Basement)</itemData>
<itemData name="callNumber">bber test 117315</itemData>
<itemData name="copy">c. 0</itemData>
<itemData name="itemBarcode"/>
<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="itemStatusCode">1</itemData>
<itemData name="itemDueDate"/>
<itemData name="itemStatusDate">2008-01-06 13:50:25</itemData>
<itemData name="todayDate">2012-03-12 12:58:02</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">2008-01-03</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">31199</itemData>
<itemData name="bibId">77616</itemData>
<itemData name="bibId">83822</itemData>
<itemData name="bibId">83821</itemData>
<itemData name="bibId">12345</itemData>
<itemData name="bibId">83820</itemData>
<itemData name="libraryId">1</itemData>
<itemData name="historicalReserveCharges">0</itemData>
<itemData name="holdLocation"/>
<itemData name="patronGroupCode"/>
<itemData name="lastName"/>
<itemData name="firstName"/>
</item>
</response>Possible Error Codes
<?xml version="1.0" encoding="UTF-8"?> <response> <reply-text>Item does not exist</reply-text> <reply-code>27</reply-code> </response>