GetHoldingsService
General Purpose
Retrieve holdings and item information for a given bibliographic record id or itemId.
Requirements
Voyager 8.2.x and higher.
Input Parameters
Parameters are included in the invoking URL.
| Parameter | Description | Value | Default | Required |
|---|---|---|---|---|
| bibId | Bib Id | integer | None | Yes/No ** |
| itemId | Item Id | integer | None | Yes/No ** |
| dbCode | Database Code | string | No | |
| link880sFlag | Indicates multiple holdings records | string | No |
Parameters are included in the invoking URL.
**either a bibId or itemId is required
Input URL Syntax
This web service can be called by GET or POST methods. If it is called by GET method, then include these three parameters in the URL.
Substitute XXXX with the bibId or itemId and YYYY with the link880sFlag and ZZZZ with the dbCode.
http://server:port/vxws/GetHoldingsService?bibId=XXXX&link880sFlag=YYYY&dbCode=ZZZZ http://server:port/vxws/GetHoldingsService?itemId=XXXX&link880sFlag=YYYY&dbCode=ZZZZ
XSD
Click here to view the ServiceParametersSchema
Click here to view the VoyagerXmlSchema
Click here to view the ServiceDataSchema
Input XML Example
This service expects to receive a ServiceParametersDocument containing the following required parameter:
bibId – the id of the bib record
Example:
<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
<ser:parameters>
<ser:parameter key="bibId">
<ser:value>51936</ser:value>
</ser:parameter>
</ser:parameters>
</ser:serviceParameters>itemId- the id of the item record.
Example:
<?xml version="1.0" encoding="UTF-8"?>
<ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
<ser:parameters>
<ser:parameter key="itemId">
<ser:value>72243</ser:value>
</ser:parameter>
</ser:parameters>
</ser:serviceParameters>Output XML Example
This service will return a VoyagerServiceDataDocument containing a holdingsCollection element which contains the holdings data.
Using a bibId
<?xml version="1.0" encoding="UTF-8" ?>
<voyagerServiceData xmlns="http://www.endinfosys.com/Voyager/serviceParameters" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:slim="http://www.loc.gov/MARC21/slim" xmlns:mfhd="http://www.endinfosys.com/Voyager/mfhd" xmlns:item="http://www.endinfosys.com/Voyager/item">
<serviceData xsi:type="hol:holdingsCollectionType" xmlns:hol="http://www.endinfosys.com/Voyager/holdings">
<hol:holdingsRecord>
<hol:bibRecord bibId="51936" dpsFlag="N">
<hol:marcRecord>
<slim:leader>01077nam a2200181Ia 4500</slim:leader>
<slim:controlfield tag="001">51936</slim:controlfield>
<slim:controlfield tag="008">850820s1896 mau 000 1 eng d</slim:controlfield>
<slim:datafield ind2=" " ind1=" " tag="035">
<slim:subfield code="a">MAP02020396</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1=" " tag="040">
<slim:subfield code="a">KSL</slim:subfield>
<slim:subfield code="c">KSL</slim:subfield>
<slim:subfield code="d">KSL</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1=" " tag="049">
<slim:subfield code="a">SHCM</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1=" " tag="092">
<slim:subfield code="a">F H327th</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="1" tag="100">
<slim:subfield code="a">Harte, Bret,</slim:subfield>
<slim:subfield code="d">1836-1902.</slim:subfield>
</slim:datafield>
<slim:datafield ind2="0" ind1="1" tag="245">
<slim:subfield code="a">Thankful Blossom, and other eastern tales and sketches /</slim:subfield>
<slim:subfield code="c">by Bret Harte.</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1=" " tag="260">
<slim:subfield code="a">Boston :</slim:subfield>
<slim:subfield code="b">Houghton Mifflin ;</slim:subfield>
<slim:subfield code="a">Cambridge, [Mass.] :</slim:subfield>
<slim:subfield code="b">Riverside Press,</slim:subfield>
<slim:subfield code="c">c1896.</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1=" " tag="300">
<slim:subfield code="a">445 p. ;</slim:subfield>
<slim:subfield code="c">18 cm.</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="1" tag="490">
<slim:subfield code="a">Writings of Bret Harte ;</slim:subfield>
<slim:subfield code="v">v. 11</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="0" tag="505">
<slim:subfield code="a">Thankful Blossom: a romance of the Jerseys -- A Jersey centenarian --Peter Schroeder -- Morning on the avenues -- My friend the tramp -- A sleeping-car experience -- The man whose yoke was not easy -- The office-seeker -- With the entre´es -- The Argonauts of North Liberty --Their uncle from California -- The ghosts of Stukeley Castle -- A rose of Glenbogie -- The heir of the McHulishes -- Young Robin Gray -- A legend of Sammtstadt -- Views from a German Spion -- The indiscretion of Elsbeth.</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="1" tag="800">
<slim:subfield code="a">Harte, Bret,</slim:subfield>
<slim:subfield code="d">1836-1902.</slim:subfield>
<slim:subfield code="t">Works ;</slim:subfield>
<slim:subfield code="v">v. 11.</slim:subfield>
</slim:datafield>
</hol:marcRecord>
<hol:bibData name="databaseCode">LOCAL</hol:bibData>
<hol:bibData name="databaseName">dev71ncdb - SysAdmin db def name</hol:bibData>
<hol:bibData name="createDate">1997-01-16 00:00:00</hol:bibData>
<hol:bibData name="updateDate" xsi:nil="true"/>
<hol:bibData name="suppressInOpac" xsi:nil="true"/>
<hol:bibData name="exportOK">N</hol:bibData>
<hol:bibData name="exportOKDate" xsi:nil="true"/>
<hol:bibData name="exportOperatorId" xsi:nil="true"/>
<hol:bibData name="createLocation" xsi:nil="true"/>
<hol:bibData name="updateLocation" xsi:nil="true"/>
<hol:bibData name="exportOKLocation" xsi:nil="true"/>
<hol:bibData name="owningLibrary" id="1">Training Master DB</hol:bibData>
</hol:bibRecord>
<hol:mfhdCollection>
<mfhd:mfhdRecord bibId="51936" mfhdId="52795">
<mfhd:marcRecord>
<slim:leader>00195cx a22000973 4500</slim:leader>
<slim:controlfield tag="001">52795</slim:controlfield>
<slim:controlfield tag="004">51936</slim:controlfield>
<slim:controlfield tag="005">19970115160834.0</slim:controlfield>
<slim:controlfield tag="008">9701150p 8 4001aueng0000000</slim:controlfield>
<slim:datafield ind2=" " ind1="1" tag="014">
<slim:subfield code="a">MAP02020396</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="8" tag="852">
<slim:subfield code="b">main</slim:subfield>
<slim:subfield code="h">F H327th</slim:subfield>
</slim:datafield>
</mfhd:marcRecord>
<mfhd:mfhdData name="databaseCode">LOCAL</mfhd:mfhdData>
<mfhd:mfhdData name="databaseName">dev71ncdb - SysAdmin db def name</mfhd:mfhdData>
<mfhd:mfhdData name="mfhdStubFlag">0</mfhd:mfhdData>
<mfhd:mfhdData name="createOperatorId" xsi:nil="true"/>
<mfhd:mfhdData name="updateOperatorId" xsi:nil="true"/>
<mfhd:mfhdData name="createDate">1997-01-16 00:00:00</mfhd:mfhdData>
<mfhd:mfhdData name="updateDate" xsi:nil="true"/>
<mfhd:mfhdData name="createLocation" xsi:nil="true"/>
<mfhd:mfhdData name="updateLocation" xsi:nil="true"/>
<mfhd:mfhdData name="suppressInOpac" xsi:nil="true"/>
<mfhd:mfhdData name="exportOK">N</mfhd:mfhdData>
<mfhd:mfhdData name="sourceModule" xsi:nil="true"/>
<mfhd:mfhdData name="callNumber">F H327th</mfhd:mfhdData>
<mfhd:mfhdData name="locationCode" id="8">main</mfhd:mfhdData>
<mfhd:mfhdData name="locationName" xsi:nil="true"/>
<mfhd:mfhdData name="locationDisplayName">Main Collection à, á, â, ã, ç, é, ê, í, ó, ô, õ, ú, ü.</mfhd:mfhdData>
<mfhd:mfhdData name="locationSpineLabel">Main</mfhd:mfhdData>
<mfhd:mfhdData name="owningLibrary" id="1">Main Library</mfhd:mfhdData>
<mfhd:itemCollection>
<item:itemCount>1</item:itemCount>
<item:itemRecord>
<item:itemData name="statusCode">1</item:itemData>
<item:itemData name="statusDate" xsi:nil="true"/>
<item:itemData name="holdLocation" xsi:nil="true"/>
<item:itemData name="requestCount">0</item:itemData>
<item:itemData name="patronGroupCode" xsi:nil="true"/>
<item:itemData name="lastName" xsi:nil="true"/>
<item:itemData name="firstName" xsi:nil="true"/>
<item:itemData name="todaysDate">2008-12-15 12:13:04</item:itemData>
<item:itemData name="enumeration" xsi:nil="true"/>
<item:itemData name="chronology" xsi:nil="true"/>
<item:itemData name="year" xsi:nil="true"/>
<item:itemData name="caption" xsi:nil="true"/>
<item:itemData name="text" xsi:nil="true"/>
<item:itemData name="copyNumber" xsi:nil="true"/>
</item:itemRecord>
</mfhd:itemCollection>
</mfhd:mfhdRecord>
</hol:mfhdCollection>
</hol:holdingsRecord>
</serviceData>
</voyagerServiceData>Using an itemId
<?xml version="1.0" encoding="UTF-8"?>
<ser:voyagerServiceData xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters">
<ser:serviceData xsi:type="hol:holdingsCollectionType" xmlns:hol="http://www.endinfosys.com/Voyager/holdings" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<hol:holdingsRecord>
<hol:mfhdCollection>
<mfhd:mfhdRecord mfhdId="68796" xmlns:mfhd="http://www.endinfosys.com/Voyager/mfhd">
<mfhd:marcRecord>
<slim:leader xmlns:slim="http://www.loc.gov/MARC21/slim">00288cx a22001454 4500</slim:leader>
<slim:controlfield tag="001" xmlns:slim="http://www.loc.gov/MARC21/slim">68796</slim:controlfield>
<slim:controlfield tag="004" xmlns:slim="http://www.loc.gov/MARC21/slim">83820</slim:controlfield>
<slim:controlfield tag="005" xmlns:slim="http://www.loc.gov/MARC21/slim">20081203151355.0</slim:controlfield>
<slim:controlfield tag="008" xmlns:slim="http://www.loc.gov/MARC21/slim">0711294u 8 1001uu 0901128</slim:controlfield>
<slim:datafield ind2=" " ind1="1" tag="014" xmlns:slim="http://www.loc.gov/MARC21/slim">
<slim:subfield code="a">83821</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="1" tag="014" xmlns:slim="http://www.loc.gov/MARC21/slim">
<slim:subfield code="a">83822</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="1" tag="014" xmlns:slim="http://www.loc.gov/MARC21/slim">
<slim:subfield code="a">77616</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="1" tag="014" xmlns:slim="http://www.loc.gov/MARC21/slim">
<slim:subfield code="a">12345</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1="1" tag="014" xmlns:slim="http://www.loc.gov/MARC21/slim">
<slim:subfield code="a">31199</slim:subfield>
</slim:datafield>
<slim:datafield ind2=" " ind1=" " tag="852" xmlns:slim="http://www.loc.gov/MARC21/slim">
<slim:subfield code="b">biology</slim:subfield>
<slim:subfield code="h">bber test 117315</slim:subfield>
</slim:datafield>
</mfhd:marcRecord>
<mfhd:mfhdData name="createOperatorId">demo</mfhd:mfhdData>
<mfhd:mfhdData name="updateOperatorId">demo</mfhd:mfhdData>
<mfhd:mfhdData name="createDate">2007-11-29 16:55:42</mfhd:mfhdData>
<mfhd:mfhdData name="updateDate">2008-12-03 15:13:55</mfhd:mfhdData>
<mfhd:mfhdData name="createLocation">Cataloging Desk</mfhd:mfhdData>
<mfhd:mfhdData name="updateLocation">Cataloging Desk</mfhd:mfhdData>
<mfhd:mfhdData name="suppressInOpac">N</mfhd:mfhdData>
<mfhd:mfhdData name="exportOK">N</mfhd:mfhdData>
<mfhd:mfhdData name="sourceModule">C</mfhd:mfhdData>
<mfhd:mfhdData name="callNumber">bber test 117315</mfhd:mfhdData>
<mfhd:mfhdData name="locationCode" id="3">biology</mfhd:mfhdData>
<mfhd:mfhdData name="locationName" xsi:nil="true"/>
<mfhd:mfhdData name="locationDisplayName">Reference Biology Stacks (Basement)</mfhd:mfhdData>
<mfhd:mfhdData name="locationSpineLabel">Bio</mfhd:mfhdData>
<mfhd:mfhdData name="owningLibrary" id="1">Main Library</mfhd:mfhdData>
<mfhd:itemCollection>
<item:itemCount xmlns:item="http://www.endinfosys.com/Voyager/item">2</item:itemCount>
<item:itemRecord xmlns:item="http://www.endinfosys.com/Voyager/item">
<item:itemData name="statusCode">1</item:itemData>
<item:itemData name="statusDate" xsi:nil="true"/>
<item:itemData name="holdLocation" xsi:nil="true"/>
<item:itemData name="requestCount">0</item:itemData>
<item:itemData name="patronGroupCode" xsi:nil="true"/>
<item:itemData name="lastName" xsi:nil="true"/>
<item:itemData name="firstName" xsi:nil="true"/>
<item:itemData name="todaysDate">2012-03-13 10:19:54</item:itemData>
<item:itemData name="enumeration" xsi:nil="true"/>
<item:itemData name="chronology" xsi:nil="true"/>
<item:itemData name="year" xsi:nil="true"/>
<item:itemData name="caption" xsi:nil="true"/>
<item:itemData name="text" xsi:nil="true"/>
<item:itemData name="copyNumber" xsi:nil="true"/>
<item:itemData name="callNumber"/>
</item:itemRecord>
<item:itemLocation xmlns:item="http://www.endinfosys.com/Voyager/item">
<item:itemLocationData name="tmpLoc" xsi:nil="true"/>
<item:itemLocationData name="tempLocation">Cataloging</item:itemLocationData>
<item:itemLocationData name="itemEnum" xsi:nil="true"/>
<item:itemLocationData name="itemChron" xsi:nil="true"/>
<item:itemLocationData name="itemYear" xsi:nil="true"/>
<item:itemLocationData name="itemCaption" xsi:nil="true"/>
<item:itemLocationData name="itemFreeText" xsi:nil="true"/>
<item:itemLocationData name="itemCopyNumber" xsi:nil="true"/>
</item:itemLocation>
<item:itemLocation xmlns:item="http://www.endinfosys.com/Voyager/item">
<item:itemLocationData name="tmpLoc">Y</item:itemLocationData>
<item:itemLocationData name="tempLocation">Acq Plus</item:itemLocationData>
<item:itemLocationData name="itemEnum" xsi:nil="true"/>
<item:itemLocationData name="itemChron" xsi:nil="true"/>
<item:itemLocationData name="itemYear" xsi:nil="true"/>
<item:itemLocationData name="itemCaption" xsi:nil="true"/>
<item:itemLocationData name="itemFreeText" xsi:nil="true"/>
<item:itemLocationData name="itemCopyNumber" xsi:nil="true"/>
</item:itemLocation>
</mfhd:itemCollection>
</mfhd:mfhdRecord>
</hol:mfhdCollection>
</hol:holdingsRecord>
</ser:serviceData>
</ser:voyagerServiceData>Note
You can use this service in combination with the Record Items RESTful service to get ttem ids to use in placing requests.