Patron Circulation Actions — Debt

NAVIGATE CONTENT
Ex Libris Developer Network Voyager Documentation Voyager APIs RESTful Web Services Patron Circulation Actions — Debt

General Purpose

The resource may be accessed with the GET method to retrieve a patron’s fines and fees and/or demerits (debt) from a patron’s home server.

Product Version Compatibility

Voyager 7.2.0 and later.

Input Parameters

ParameterTypeDescriptionValueDefaultRequired
patron IDpath parameterVoyager 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.stringNoneYes
patron_homedbquery parameterVoyager patron home DB keystringNoneYes
institutionquery parameterThe database code from SysAdmin -> search -> Database Definitions. This is to retrieve debt for the patron in a specific database.stringNoneNo
viewquery parameterIf view=brief, a subset of the debt information is displayed.
If view=full, all pertinent debt information is displayed.		stringNoneNo

Ensure that the “demerits” and “demeritsdisplay” rows in your global_parm table are set to “Y” to include demerits in your responses from the service.

Input URL Syntax

The following is an example of input URL to retrieve patron debt information:

http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt?patron_homedb=1@DMADB20010103091142

The following is an example of input URL to retrieve patron debt information from a specific database:

http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt?patron_homedb=1@DMADB20010103091142&institution=GWCC

The following is an example of input URL to retrieve patron fines information (patron fines also include demerit information):

http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines?patron_homedb=1@DMADB20010103091142

The following is an example of input URL to retrieve patron fines information from a specific database (patron fines also include demerit information):

http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines?patron_homedb=1@DMADB20010103091142&institution=GWCC

The following is an example of input URL to retrieve patron fines information with view=brief (patron fines also include demerit information):

http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines?patron_homedb=1@DMADB20010103091142&view=brief

The following is an example of input URL to retrieve patron fines information with view=full (patron fines also include demerit information):

http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines?patron_homedb=1@DMADB20010103091142&view=full

The following is an example of input URL to retrieve specific patron fines information (patron fines also include demerit information):

http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines?patron_homedb=1@DMADB20010103091142&view=full

Output XML Format

The following is an output example of patron debt:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <debts>
      <institution id="GWCC">
          <instName>ubgwcc720db</instName>
          <debt href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines?institution=GWCC&patron_homedb=1@DMADB20010103091142">
                <finesum>USD 21.00</finesum>
                <demeritsum>21.00</demeritsum>
          </debt>
      </institution>
      <institution id="LOCAL">
          <instName>DEV720DMADB</instName>
          <debt href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines?institution=LOCAL&patron_homedb=1@DMADB20010103091142">
                <finesum>USD 117.00</finesum>
          </debt>
      </institution>
  </debts>
</response>

The following is an output example of patron debt from a specific institution:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <debts>
      <institution id="GWCC">
          <instName>ubgwcc720db</instName>
          <debt href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines?institution=GWCC&patron_homedb=1@DMADB20010103091142">
              <finesum>USD 21.00</finesum>
              <demeritsum>21.00</demeritsum>
          </debt>
      </institution>
  </debts>
</response>

The following is an output example of patron fines:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <fines>
      <institution id="GWCC">
          <instName>ubgwcc720db</instName>
          <balance>
              <finesum>USD 21.00</finesum>
              <demeritsum>21.00</demeritsum>
          </balance>
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/156?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/150?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/156?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/150?patron_homedb=1@DMADB20010103091142" />
          </institution>
      <institution id="LOCAL">
          <instName>DEV720DMADB</instName>
          <balance>
          <finesum>USD 117.00</finesum>
          </balance>
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/1013?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/1017?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/1016?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/1016?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/1015?patron_homedb=1@DMADB20010103091142" />
      </institution>
  </fines>
</response>

The following is an output example of patron fines for a specific institution:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <fines>
      <institution id="GWCC">
          <instName>ubgwcc720db</instName>
          <balance>
          <finesum>USD 21.00</finesum>
          <demeritsum>21.00</demeritsum>
          </balance>
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/156?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/150?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/156?patron_homedb=1@DMADB20010103091142" />
          <fine href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/debt/fines/150?patron_homedb=1@DMADB20010103091142" />
      </institution>
  </fines>
</response>

The following is an output example of specific patron fines:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <resource>
      <fine>
          <fineId>156</fineId>
          <fineDate>2009-12-09</fineDate>
          <itemTitle>Introduction to comparative entomology [by] Richard M. Fox [and] Jean Walker Fox.</itemTitle>
          <fineType>Overdue</fineType>
          <amount>USD 20.00</amount>
          <dbKey>GWCCDB20010402131061</dbKey>
          <dbName>GWCC</dbName>
          <instName>ubgwcc720db</instName>
      </fine>
      <fine>
          <fineId>156</fineId>
          <fineDate>2009-12-09</fineDate>
          <itemTitle>Introduction to comparative entomology [by] Richard M. Fox [and] Jean Walker Fox.</itemTitle>
          <fineType>Overdue</fineType>
          <amount>Demerits: 20.00</amount>
          <dbKey>GWCCDB20010402131061</dbKey>
          <dbName>GWCC</dbName>
          <instName>ubgwcc720db</instName>
      </fine>
  </resource>
</response>

Possible Error Codes

2: Patron ID is not found
51: patron_homedb is a required parameter

Note

Payments against a fine/fee will be returned in a <fineType> element with a value of “Payment”.  Its associated <fineDate> is the date the payment was made.  In the example below, a fine of $10 was incurred on 2014-07-24, and  $4 of it was paid on 2014-07-28.

<fine href= "http://10.100.3.87:61314/vxws/patron/152/circulationActions/debt/fines/10353?patron_homedb=1@QA20012DB20020613131313" >
     <fineId>10353</fineId>
     <fineDate>2014-07-24</fineDate>
     <itemTitle/>
     <fineType>Media Booking Late Charge</fineType>
     <amount>USD 10.00</amount>
     <dbKey>1@QA20012DB20020613131313</dbKey>
     <dbName>DEV910NCDB</dbName>
</fine>
<fine href= "http://10.100.3.87:61314/vxws/patron/152/circulationActions/debt/fines/10353?patron_homedb=1@QA20012DB20020613131313" >
     <fineId>10353</fineId>
     <fineDate>2014-07-28</fineDate>   
     <itemTitle/>
     <fineType>Payment</fineType>
     <amount>USD 4.00</amount>
     <dbKey>1@QA20012DB20020613131313</dbKey>
     <dbName>DEV910NCDB</dbName>
</fine>