Patron Circulation Actions — Requests
General Purpose
The resource may be accessed with the GET method to retrieve a patron’s requests from the patron home server.
The resource may be accessed with the DELETE method to cancel a patron’s request.
Product Version Compatibility
Voyager 7.2.0 and later.
Input Parameters
Parameter | Type | Description | Value | Default | Required |
---|---|---|---|---|---|
patron ID | path parameter | 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. | string | None | Yes |
patron_homedb | query parameter | Voyager patron home DB key | string | None | Yes |
request ID | path parameter | This is the <dbkey>|request. For example, GWCCDB20010402131061|8465 as input to retrieve or cancel a request. | string | None | Required for retrieving or canceling a specific request. |
institution | query parameter | The database code from SysAdmin -> search -> Database Definitions. This is to retrieve requested items for the patron in a specific database. | string | None | No |
view | query parameter | If view=brief, a subset of the requested item information is displayed. If view=full, all pertinent requested item information is displayed. | 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 the URL to retrieve all patron requests:
http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests?patron_homedb=1@DMADB20010103091142
The following is an example of the URL to retrieve all holds requests for a patron:
http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds?patron_homedb=1@DMADB20010103091142
The following is an example of a URL to retrieve a specific patron holds request:
The HTTP DELETE method is used to cancel the specific request.
http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds/DMADB20010103091142%7C32?patron_homedb=1@DMADB20010103091142
The following is an example of a URL to retrieve all holds requests for a patron in a specific database:
http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds?patron_homedb=1@DMADB20010103091142&institution=GWCC
The following is an example of a URL to retrieve all holds requests for a patron with view=brief:
http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds?patron_homedb=1@DMADB20010103091142&view=brief
The following is an example of a URL to retrieve all holds requests for a patron with view=full:
http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds?patron_homedb=1@DMADB20010103091142&view=full
The following is an example of a URL to retrieve all call slip requests for a patron:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips?patron_homedb=1@QA20012DB20020613131313
The following is an example of a URL to retrieve a specific patron call slip request:
The HTTP DELETE method is used to cancel the specific request.
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips/QA20012DB20020613131313%7C931?patron_homedb=1@QA20012DB20020613131313
The following is an example of a URL to retrieve all call slip requests for a patron in a specific database:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips?patron_homedb=1@QA20012DB20020613131313&institution=LOCAL
The following is an example of a URL to retrieve all call slip requests for a patron with view=brief:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips?patron_homedb=1@QA20012DB20020613131313&view=brief
The following is an example of a URL to retrieve all holds requests for a patron with view=full:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips?patron_homedb=1@QA20012DB20020613131313&view=full
The following is an example of a URL to retrieve all short loans requests for a patron:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans?patron_homedb=1@QA20012DB20020613131313
The following is an example of a URL to retrieve a specific patron short loan request:
The HTTP DELETE method is used to cancel the specific request.
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans/QA20012DB20020613131313%7C143?patron_homedb=1@QA20012DB20020613131313
The following is an example of a URL to retrieve all short loans requests for a patron in a specific database:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans?patron_homedb=1@QA20012DB20020613131313&institution=LOCAL
The following is an example of a URL to retrieve all short loans requests for a patron with view=brief:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans?patron_homedb=1@QA20012DB20020613131313&view=brief
The following is an example of a URL to retrieve all media bookings requests for a patron:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings?patron_homedb=1@QA20012DB20020613131313
The following is an example of a URL to retrieve a specific patron media booking request:
The HTTP DELETE method is used to cancel the specific request.
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings/QA20012DB20020613131313%7C612?patron_homedb=1@QA20012DB20020613131313
The following is an example of a URL to retrieve all media bookings requests for a patron in a specific database:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313
The following is an example of a URL to retrieve all media bookings requests for a patron with view=brief:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings?patron_homedb=1@QA20012DB20020613131313&view=brief
The following is an example of a URL to retrieve all media bookings requests for a patron with view=full:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings?patron_homedb=1@QA20012DB20020613131313&view=full
The following is an example of a URL to retrieve a summary of all ILL requests for a patron:
http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests?patron_homedb=1@QA20012DB20020613131313
The following is an example of a URL to retrieve all detail ILL requests for a patron with view = brief:
http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests?view=brief&patron_homedb=1@QA20012DB20020613131313
Note that a user cannot cancel or renew ILL requests in Voyager
The following is an example of a URL to retrieve a specific ILL request for a patron:
http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests/QA20012DB20020613131313%7C201086?patron_homedb=1@QA20012DB20020613131313
Note: To cancel a UB request, use the XML Over HTTP Cancel service.
Output XML Format
The following is an output example of all patron requests:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <requests> <institution id="LOCAL"> <instName>University Library</instName> <request type="HoldRequest" href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/holds?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313"> <number>1</number> </request> <request type="CallSlip" href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313"> <number>1</number> </request> <request type="ShortLoan" href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313"> <number>1</number> </request> <request type="Bookings" href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313"> <number>1</number> </request> </institution> </requests> </response>
The following is an output example of all patron requests across different databases:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <requests> <institution id="LOCAL"> <instName>DEV720DMADB</instName> <request type="HoldRequest" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds?institution=LOCAL&patron_homedb=1@DMADB20010103091142"> <number>1</number> </request> <request type="CallSlip" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/callslips?institution=LOCAL&patron_homedb=1@DMADB20010103091142"> <number>1</number> </request> </institution> <institution id="GWCC"> <instName>ubgwcc720db</instName> <request type="HoldRequest" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds?institution=GWCC&patron_homedb=1@DMADB20010103091142"> <number>1</number> </request> </institution> <institution id="RSCC"> <instName>ubrscc720db</instName> <request type="CallSlip" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/callslips?institution=RSCC&patron_homedb=1@DMADB20010103091142"> <number>1</number> </request> </institution> </requests> </response>
The following is an example of the output of all holds requests for a patron:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <holds> <institution id="LOCAL"> <instName>DEV720DMADB</instName> <hold href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds/DMADB20010103091142|32?patron_homedb=1@DMADB20010103091142" /> </institution> <institution id="GWCC"> <instName>ubgwcc720db</instName> <hold href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds/GWCCDB20010402131061|33?patron_homedb=1@DMADB20010103091142" /> </institution> </holds> </response>
The following is an example of the output of all holds requests for a patron on a specific database:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <holds> <institution id="GWCC"> <instName>ubgwcc720db</instName> <hold href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds/GWCCDB20010402131061|33?patron_homedb=1@DMADB20010103091142" /> </institution> </holds> </response>
The following is an example of the output of all holds requests for a patron with view=brief:
The holdType element is Hold (H), Recall (Recall), Call slip (C), or UB Request (U).
NOTE: A hold request also includes items that are recalled.
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <holds> <institution id="LOCAL"> <instName>DEV720DMADB</instName> <hold href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds/DMADB20010103091142|32?patron_homedb=1@DMADB20010103091142"> <requestItem> <itemId>21</itemId> <holdRecallId>32</holdRecallId> <replyNote /> <status>1</status> <statusText>Position 1: Expires 2009-12-24</statusText> <holdType>R</holdType> <itemTitle>1986 ARTnews directory of corporate art collections / Shirley Reiff Howarth, editor.</itemTitle> <expiredDate>2009-12-24</expiredDate> <dbKey>DMADB20010103091142</dbKey> <dbName>DMA</dbName> <queuePosition>1</queuePosition> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>Circ</pickupLocationCode> </requestItem> </hold> </institution> <institution id="GWCC"> <instName>ubgwcc720db</instName> <hold href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds/GWCCDB20010402131061|33?patron_homedb=1@DMADB20010103091142"> <requestItem> <itemId>22948</itemId> <holdRecallId>33</holdRecallId> <replyNote /> <status>1</status> <statusText>Position 1: Expires 2010-01-09</statusText> <holdType>H</holdType> <itemTitle>Salt book : lobstering, sea moss pudding, stone walls, rum running, maple syrup, snowshoes, and other Yankee doings / edited with an introd. by Pamela Wood.</itemTitle> <expiredDate>2010-01-09</expiredDate> <dbKey>GWCCDB20010402131061</dbKey> <dbName>GWCC</dbName> <queuePosition>1</queuePosition> <pickupLocation>DWC-Res</pickupLocation> <pickupLocationCode>DWC-Res</pickupLocationCode> </requestItem> </hold> </institution> </holds> </response>
The following is an example of the output of all holds requests for a patron with view=full:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <holds> <institution id="LOCAL"> <instName>DEV720DMADB</instName> <hold href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests/holds/DMADB20010103091142|33?patron_homedb=1@DMADB20010103091142"> <requestItem> <itemId>21</itemId> <holdRecallId>33</holdRecallId> <replyNote /> <status>1</status> <statusText>Position 1: Expires 2010-01-09</statusText> <holdType>R</holdType> <itemTitle>1986 ARTnews directory of corporate art collections / Shirley Reiff Howarth, editor.</itemTitle> <expiredDate>2010-01-09</expiredDate> <dbKey>DMADB20010103091142</dbKey> <dbName>DMA</dbName> <queuePosition>1</queuePosition> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>Circ</pickupLocationCode> </requestItem> </hold> </institution> </holds> </response>
The following is an example of the output of a specific hold request:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <hold> <requestItem> <itemId>21</itemId> <holdRecallId>32</holdRecallId> <replyNote /> <status>1</status> <statusText>Position 1: Expires 2009-12-24</statusText> <holdType>R</holdType> <itemTitle>1986 ARTnews directory of corporate art collections / Shirley Reiff Howarth, editor.</itemTitle> <expiredDate>2009-12-24</expiredDate> <dbKey>DMADB20010103091142</dbKey> <dbName>DMA</dbName> <queuePosition>1</queuePosition> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>Circ</pickupLocationCode> <instName>DEV720DMADB</instName> </requestItem> </hold> </response>
The following is an example of the output of canceling a specific request:
<?xml version="1.0" encoding="UTF-8"?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <cancel-hold> <note type="info"/> </cancel-hold> </response>
The following is an example of the output of failing to cancel a specific request:
<?xml version="1.0" encoding="UTF-8"?> <response> <reply-text>Combination of patron and sub-element not valid</reply-text> <reply-code>3</reply-code> <cancel-hold> <note type="error"/> </cancel-hold> </response>
The following is an example of the output of all call slip requests for a patron:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <callslips> <institution id="LOCAL"> <instName>University Library</instName> <callslip href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips/QA20012DB20020613131313|931?patron_homedb=1@QA20012DB20020613131313" /> </institution> </callslips> </response>
The following is an example of the output of all call slip requests for a patron for a specific database:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <callslips> <institution id="LOCAL"> <instName>University Library</instName> <callslip href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips/QA20012DB20020613131313|931?patron_homedb=1@QA20012DB20020613131313" /> </institution> </callslips> </response>
The following is an example of the output of all call slip requests for a patron with view=brief:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <callslips> <institution id="LOCAL"> <instName>University Library</instName> <callslip href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips/QA20012DB20020613131313|931?patron_homedb=1@QA20012DB20020613131313"> <requestItem> <itemId>0</itemId> <holdRecallId>931</holdRecallId> <replyNote /> <status>1</status> <statusText>Accepted 2009-09-08</statusText> <holdType>C</holdType> <itemTitle>Itemless call slip test record</itemTitle> <expiredDate>2009-09-08</expiredDate> <dbKey>QA20012DB20020613131313</dbKey> <dbName>VOYDEV</dbName> <queuePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" /> <pickupLocation>Medical Lib:Main Collection</pickupLocation> <pickupLocationCode>main</pickupLocationCode> </requestItem> </callslip> </institution> </callslips> </response>
The following is an example of the output of all call slip requests for a patron with view=full:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <callslips> <institution id="LOCAL"> <instName>University Library</instName> <callslip href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/callslips/QA20012DB20020613131313|931?patron_homedb=1@QA20012DB20020613131313"> <requestItem> <itemId>0</itemId> <holdRecallId>931</holdRecallId> <replyNote /> <status>1</status> <statusText>Accepted 2009-09-08</statusText> <holdType>C</holdType> <itemTitle>Itemless call slip test record</itemTitle> <expiredDate>2009-09-08</expiredDate> <dbKey>QA20012DB20020613131313</dbKey> <dbName>VOYDEV</dbName> <queuePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" /> <pickupLocation>Medical Lib:Main Collection</pickupLocation> <pickupLocationCode>main</pickupLocationCode> </requestItem> </callslip> </institution> </callslips> </response>
The following is an example of the output of a specific call slip request:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <callslip> <requestItem> <itemId>0</itemId> <holdRecallId>931</holdRecallId> <replyNote /> <status>1</status> <statusText>Accepted 2009-09-08</statusText> <holdType>C</holdType> <itemTitle>Itemless call slip test record</itemTitle> <expiredDate>2009-09-08</expiredDate> <dbKey>QA20012DB20020613131313</dbKey> <dbName>VOYDEV</dbName> <queuePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" /> <pickupLocation>Medical Lib:Main Collection</pickupLocation> <pickupLocationCode>main</pickupLocationCode> <instName>University Library</instName> </requestItem> </callslip> </response>
The following is an example of the output of all short loan requests for a patron:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <shortloans> <institution id="LOCAL"> <instName>University Library</instName> <shortloan href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans/QA20012DB20020613131313|143?patron_homedb=1@QA20012DB20020613131313" /> </institution> </shortloans> </response>
The following is an example of the output of all short loan requests for a patron for a specific database:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <shortloans> <institution id="LOCAL"> <instName>University Library</instName> <shortloan href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans/QA20012DB20020613131313|143?patron_homedb=1@QA20012DB20020613131313" /> </institution> </shortloans> </response>
The following is an example of the output of all short loan requests for a patron with view=brief:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <shortloans> <institution id="LOCAL"> <instName>University Library</instName> <shortloan href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans/QA20012DB20020613131313|143?patron_homedb=1@QA20012DB20020613131313"> <requestItem> <itemId>69146</itemId> <holdRecallId>143</holdRecallId> <replyNote /> <status>1</status> <statusText>( 2009-12-10 20:00-2009-12-10 21:00 ) Pick up at Acquisitions</statusText> <holdType>S</holdType> <itemTitle>Short loan with more than 20 items test</itemTitle> <dbKey>QA20012DB20020613131313</dbKey> <dbName>VOYDEV</dbName> <queuePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" /> <pickupLocation>Acquisitions</pickupLocation> <pickupLocationCode>ACQ</pickupLocationCode> <startTime>2009-12-10 20:00</startTime> <endTime>2009-12-10 21:00</endTime> </requestItem> </shortloan> </institution> </shortloans> </response>
The following is an example of the output of all short loan requests for a patron with view=full:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <shortloans> <institution id="LOCAL"> <instName>University Library</instName> <shortloan href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/shortloans/QA20012DB20020613131313|143?patron_homedb=1@QA20012DB20020613131313"> <requestItem> <itemId>69146</itemId> <holdRecallId>143</holdRecallId> <replyNote /> <status>1</status> <statusText>( 2009-12-10 20:00-2009-12-10 21:00 ) Pick up at Acquisitions</statusText> <holdType>S</holdType> <itemTitle>Short loan with more than 20 items test</itemTitle> <dbKey>QA20012DB20020613131313</dbKey> <dbName>VOYDEV</dbName> <queuePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" /> <pickupLocation>Acquisitions</pickupLocation> <pickupLocationCode>ACQ</pickupLocationCode> <startTime>2009-12-10 20:00</startTime> <endTime>2009-12-10 21:00</endTime> </requestItem> </shortloan> </institution> </shortloans> </response>
The following is an example of the output of a specific short loan request for a patron:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <shortloan> <requestItem> <itemId>69146</itemId> <holdRecallId>143</holdRecallId> <replyNote /> <status>1</status> <statusText>( 2009-12-10 20:00-2009-12-10 21:00 ) Pick up at Acquisitions</statusText> <holdType>S</holdType> <itemTitle>Short loan with more than 20 items test</itemTitle> <dbKey>QA20012DB20020613131313</dbKey> <dbName>VOYDEV</dbName> <queuePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" /> <pickupLocation>Acquisitions</pickupLocation> <pickupLocationCode>ACQ</pickupLocationCode> <startTime>2009-12-10 20:00</startTime> <endTime>2009-12-10 21:00</endTime> <instName>University Library</instName> </requestItem> </shortloan> </response>
The following is an example of the output of all media bookings requests for a patron:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <bookings> <institution id="LOCAL"> <instName>University Library</instName> <booking href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings/QA20012DB20020613131313|612?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313" delete="Y" /> </institution> </bookings> </response>
The following is an example of the output of all holds requests for a patron on a specific database:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <bookings> <institution id="LOCAL"> <instName>University Library</instName> <booking href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings/QA20012DB20020613131313|612?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313" delete="Y" /> </institution> </bookings> </response>
The following is an example of the output of all media bookings requests for a patron with view=brief:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <bookings> <institution id="LOCAL"> <instName>University Library</instName> <booking href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings/QA20012DB20020613131313|612?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313" delete="Y"> <requestItem> <holdRecallId>612</holdRecallId> <holdType>M</holdType> <itemTitle>Baseball : an illustrated history / narrative by Geoffrey C. Ward ; based on a documentary filmscript by Geoffrey C. Ward and Ken Burns ; preface by Ken Burns and Lynn Novick ; with an introduction by Roger Angell ; contributions by John Thorn ... [et al.</itemTitle> <itemType>Videocassette Recording</itemType> <dbKey>QA20012DB20020613131313</dbKey> <dbName>University Library</dbName> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>CIRC</pickupLocationCode> <startTime>2009-12-10 20:00</startTime> <endTime>2009-12-10 20:00</endTime> </requestItem> </booking> </institution> </bookings> </response>
The following is an example of the output of all media bookings requests for a patron with view=full:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <bookings> <institution id="LOCAL"> <instName>University Library</instName> <booking href="http://10.100.2.37:30114/vxws/patron/1000007/circulationActions/requests/bookings/QA20012DB20020613131313|612?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313" delete="Y"> <requestItem> <holdRecallId>612</holdRecallId> <holdType>M</holdType> <itemTitle>Baseball : an illustrated history / narrative by Geoffrey C. Ward ; based on a documentary filmscript by Geoffrey C. Ward and Ken Burns ; preface by Ken Burns and Lynn Novick ; with an introduction by Roger Angell ; contributions by John Thorn ... [et al.</itemTitle> <itemType>Videocassette Recording</itemType> <dbKey>QA20012DB20020613131313</dbKey> <dbName>University Library</dbName> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>CIRC</pickupLocationCode> <startTime>2009-12-10 20:00</startTime> <endTime>2009-12-10 20:00</endTime> </requestItem> </booking> </institution> </bookings> </response>
The following is an example of the output of a specific media bookings requests for a patron:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <booking delete="Y"> <requestItem> <holdRecallId>612</holdRecallId> <holdType>M</holdType> <itemTitle>Baseball : an illustrated history / narrative by Geoffrey C. Ward ; based on a documentary filmscript by Geoffrey C. Ward and Ken Burns ; preface by Ken Burns and Lynn Novick ; with an introduction by Roger Angell ; contributions by John Thorn ... [et al.</itemTitle> <itemType>Videocassette Recording</itemType> <dbKey>QA20012DB20020613131313</dbKey> <dbName>University Library</dbName> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>CIRC</pickupLocationCode> <startTime>2009-12-10 20:00</startTime> <endTime>2009-12-10 20:00</endTime> <instName>University Library</instName> </requestItem> </booking> </response>
The following is an example of the summary output of all requests for a patron including ILL request:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <requests> <institution id="LOCAL"> <instName>DEV900NCDB</instName> <request type="HoldRequest" href="http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/holds?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313"> <number>1</number> </request> <request type="IllRequests" href="http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests?institution=LOCAL&patron_homedb=1@QA20012DB20020613131313"> <number>2</number> </request> </institution> </requests> </response>
The following is an example of the summary output of all ILL requests for a patron:
<?xml version="1.0" encoding="UTF-8" ?> <reply-text>ok</reply-text> <reply-code>0</reply-code> <ill-requests> <institution id="LOCAL"> <instName>DEV900NCDB</instName> <ill-request href="http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests/QA20012DB20020613131313|201086?patron_homedb=1@QA20012DB20020613131313" /> <ill-request href="http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests/QA20012DB20020613131313|201087?patron_homedb=1@QA20012DB20020613131313" /> <ill-request href="http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests/QA20012DB20020613131313|201088?patron_homedb=1@QA20012DB20020613131313" /> </institution> </ill-requests> </response>
The following is an example of the detail output of all ILL requests for a patron with view=full:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <ill-requests> <institution id="LOCAL"> <instName>DEV900NCDB</instName> <ill-request href="http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests/QA20012DB20020613131313|201087?patron_homedb=1@QA20012DB20020613131313"> <requestItem> <attributes>No attributes; cannot cancel or renew ILL requests in Voyager</attributes> <ILLReqId>201087</ILLReqId> <status>Pending</status> <statusText>Pending</statusText> <statusDate>2013-03-24 00:00:00</statusDate> <holdType>P</holdType> <itemTitle>San Frnacisco Giants</itemTitle> <itemAuthor>Buster Posey</itemAuthor> <dbKey>QA20012DB20020613131313</dbKey> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>CIRC</pickupLocationCode> <instName>VOYDEV</instName> </requestItem> </ill-request> <ill-request href="http://10.100.2.37:40514/vxws/patron/1000007/circulationActions/requests/illRequests/QA20012DB20020613131313|201088?patron_homedb=1@QA20012DB20020613131313"> <requestItem> <attributes>No attributes; cannot cancel or renew ILL requests in Voyager</attributes> <ILLReqId>201088</ILLReqId> <status>Pending</status> <statusText>Pending</statusText> <statusDate>2013-03-26 00:00:00</statusDate> <holdType>I</holdType> <itemTitle>San Francisco 49ers</itemTitle> <itemAuthor>Colin Kaperneck</itemAuthor> <dbKey>QA20012DB20020613131313</dbKey> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>CIRC</pickupLocationCode> <instName>VOYDEV</instName> </requestItem> </ill-request> </institution> </ill-requests> </response>
The following is an example of output of a specific ILL request:
<?xml version="1.0" encoding="UTF-8" ?> <response> <reply-text>ok</reply-text> <reply-code>0</reply-code> <ill-request> <requestItem> <attributes>No attributes; cannot cancel or renew ILL requests in Voyager</attributes> <ILLReqId>201086</ILLReqId> <status>Pending</status> <statusText>Pending</statusText> <statusDate>2013-03-21 00:00:00</statusDate> <holdType>I</holdType> <itemTitle>San Frnacisco 49ers</itemTitle> <itemAuthor>Collin Kaperneck</itemAuthor> <dbKey>QA20012DB20020613131313</dbKey> <pickupLocation>Circulation Desk</pickupLocation> <pickupLocationCode>CIRC</pickupLocationCode> <instName>VOYDEV</instName> </requestItem> </ill-request> </response>
Possible Error Codes
2: The patron ID is not found
8: Request does not exist
3: Combination of patron and sub-element not valid
51: patron_homedb is a required parameter
52: dbkey is a required parameter