Record Holdings
General Purpose
This resource may be accessed with a GET method to retrieve holdings for a specific bibliographic record from the record home server.
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 |
holdings ID | query parameter | Voyager holdings ID. This is optional. If it is specified on the URL path, the specific MARC record for the holdings information is returned. | string | None | No |
view | query parameter | If view=full, a MARC record of the holdings is displayed. If view=items, a MARC record of the holdings and the items information is displayed. | string | None | No |
noItems | query parameter | If view=items, including noItems will limit the number of items returned for each holding. For example, “noItems=6” specifies to return no more than 6 items per holding. If it results in partial results, the <partial> element is included with “Y”. If it results in complete results, the <partial> element is included with “N”. | integer | None | No |
Input URL Syntax
The following is an example of a URL to retrieve holdings information for the specific bibliographic record:
http://10.100.2.37:30114/vxws/record/50000/holdings
The following is an example of a URL to retrieve holdings information for the specific bibliographic record with detailed holdings MARC record:
http://10.100.2.37:30114/vxws/record/50000/holdings?view=full
The following is an example of a URL to retrieve holdings information for the specific bibliographic record with detailed holdings MARC record and items data:
http://10.100.2.37:30114/vxws/record/50000/holdings?view=items
The following is an example of a URL to retrieve holdings information for the specific bibliographic record with detailed holdings MARC record and items data, limiting the number of items returned per holding to 2:
http://10.100.2.37:30114/vxws/record/50000/holdings?view=items&noItems=2
The following is an example of a URL to retrieve specific holdings information for a specific bibliographic record with a detailed holdings MARC record:
http://10.100.2.37:30114/vxws/record/50000/holdings/50820
Output XML Format
The following is an example of output holdings information for a specific bibliographic record:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <holdings> <institution id="LOCAL"> <instName>University Library</instName> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/50820" /> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69370" /> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69371" /> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69372" /> </institution> </holdings> </response>
The following is an example of output holdings information for a specific bibliographic record with MARC information for the holdings:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <holdings> <institution id="LOCAL"> <instName>University Library</instName> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/50820"> <marcRecord> <leader>00199cx a22000973 4500</leader> <controlfield tag="001">50820</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080911141306.0</controlfield> <controlfield tag="008">9701150p 8 4001aueng0000000</controlfield> <datafield ind2="" ind1="1" tag="014"> <subfield code="a">DJT02057191</subfield> </datafield> <datafield ind2="" ind1="8" tag="852"> <subfield code="b">main</subfield> <subfield code="h">220.7 B58ma1</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> </holding> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69370"> <marcRecord> <leader>00163nx a22000854 4500</leader> <controlfield tag="001">69370</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080916091557.0</controlfield> <controlfield tag="008">0809164u 8 1001uu 0901128</controlfield> <datafield ind2="" ind1="0" tag="852"> <subfield code="b">main</subfield> <subfield code="h">a123</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> </holding> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69371"> <marcRecord> <leader>00163nx a22000854 4500</leader> <controlfield tag="001">69371</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080916091638.0</controlfield> <controlfield tag="008">0809164u 8 1001uu 0901128</controlfield> <datafield ind2="" ind1="0" tag="852"> <subfield code="b">main</subfield> <subfield code="h">a456</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> </holding> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69372"> <marcRecord> <leader>00169nx a22000854 4500</leader> <controlfield tag="001">69372</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080916091924.0</controlfield> <controlfield tag="008">0809164u 8 1001uu 0901128</controlfield> <datafield ind2="" ind1="0" tag="852"> <subfield code="b">main</subfield> <subfield code="h">a789</subfield> <subfield code="i">b123</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> </holding> </institution> </holdings> </response>
The following is an out example of holdings information for a specific bibliographic record with a detailed holdings MARC record and items information:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <holdings> <institution id="LOCAL"> <instName>University Library</instName> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/50820"> <marcRecord> <leader>00199cx a22000973 4500</leader> <controlfield tag="001">50820</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080911141306.0</controlfield> <controlfield tag="008">9701150p 8 4001aueng0000000</controlfield> <datafield ind2="" ind1="1" tag="014"> <subfield code="a">DJT02057191</subfield> </datafield> <datafield ind2="" ind1="8" tag="852"> <subfield code="b">main</subfield> <subfield code="h">220.7 B58ma1</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> <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> </holding> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69370"> <marcRecord> <leader>00163nx a22000854 4500</leader> <controlfield tag="001">69370</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080916091557.0</controlfield> <controlfield tag="008">0809164u 8 1001uu 0901128</controlfield> <datafield ind2="" ind1="0" tag="852"> <subfield code="b">main</subfield> <subfield code="h">a123</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> </holding> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69371"> <marcRecord> <leader>00163nx a22000854 4500</leader> <controlfield tag="001">69371</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080916091638.0</controlfield> <controlfield tag="008">0809164u 8 1001uu 0901128</controlfield> <datafield ind2="" ind1="0" tag="852"> <subfield code="b">main</subfield> <subfield code="h">a456</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> <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> </holding> <holding href="http://10.100.2.37:30114/vxws/record/50000/holdings/69372"> <marcRecord> <leader>00169nx a22000854 4500</leader> <controlfield tag="001">69372</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080916091924.0</controlfield> <controlfield tag="008">0809164u 8 1001uu 0901128</controlfield> <datafield ind2="" ind1="0" tag="852"> <subfield code="b">main</subfield> <subfield code="h">a789</subfield> <subfield code="i">b123</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> <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> </holding> </institution> </holdings> </response>
The following is an example of specific holdings information for a specific bibliographic record:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <holding> <marcRecord> <leader>00199cx a22000973 4500</leader> <controlfield tag="001">50820</controlfield> <controlfield tag="004">50000</controlfield> <controlfield tag="005">20080911141306.0</controlfield> <controlfield tag="008">9701150p 8 4001aueng0000000</controlfield> <datafield ind2="" ind1="1" tag="014"> <subfield code="a">DJT02057191</subfield> </datafield> <datafield ind2="" ind1="8" tag="852"> <subfield code="b">main</subfield> <subfield code="h">220.7 B58ma1</subfield> </datafield> <datafield tag="954" ind1="" ind2=""> <subfield code="a">Main Library</subfield> </datafield> </marcRecord> </holding> </response>
Possible Error Codes
19: Record does not exist