Patron Circulation Actions
General Purpose
This resource may be accessed with the GET method to retrieve patron circulation actions such as loans or requests from the patron home server.
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 |
Input URL Syntax
The following is an example of a URL to retrieve the patron circulation actions from the patron home server:
http://10.100.2.37:30114/vxws/patron/1000007/circulationActions?patron_homedb=1@QA20012DB20020613131313
Output XML Format
The following an output example of the patron circulation actions from the patron home server:
<?xml version="1.0" encoding="UTF-8" ?>
<response>
<reply-text>ok</reply-text>
<reply-code>0</reply-code>
<circulationActions>
<institution id="GWCC">
<instName>ubgwcc720db</instName>
<action type="loans" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans?institution=GWCC&patron_homedb=1@DMADB20010103091142">
<amount>1</amount>
</action>
<action type="Debt" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt?institution=GWCC&patron_homedb=1@DMADB20010103091142">
<demeritsum>1.00</demeritsum>
<finesum>USD 1.00</finesum>
</action>
</institution>
<institution id="LOCAL">
<instName>DMA</instName>
<action type="loans" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans?institution=LOCAL&patron_homedb=1@DMADB20010103091142">
<amount>2</amount>
</action>
<action type="Debt" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt?institution=LOCAL&patron_homedb=1@DMADB20010103091142">
<finesum>USD 217.00</finesum>
</action>
</institution>
<institution id="RSCC">
<instName>ubrscc720db</instName>
<action type="requests" href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/requests?institution=RSCC&patron_homedb=1@DMADB20010103091142">
<amount>1</amount>
</action>
</institution>
<total>
<total type="Loans">3</total>
<total type="Fines">USD 218.00</total>
<total type="Demerits">1.00</total>
<total type="Requests">1</total>
</total>
</circulationActions>
</response>Possible Error Codes
2: The patron ID is not found
51: patron_homedb is a required parameter