Patron Circulation Actions — Loans

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

General Purpose

The resource may be accessed with a GET command to retrieve the patron charged item information from the patron home server.

The resource may be accessed with a POST command to renew a patron charged item.

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
loan IDpath parameterThis is the <dbkey>|item ID. For example, 1@GWCCDB20010402131061|8465 as input to retrieve or renew a loan.stringNoneMay be required to retrieve or renew a specific loan
institutionquery parameterThe database code from SysAdmin -> search -> Database Definitions. This is to retrieve charged items for the patron in a specific database.stringNoneNo
viewquery parameterIf view=brief, a subset of the charged item information is displayed.
If view=full, all pertinent charged item information is displayed.		stringNoneNo
lang.query parameterThree-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.stringNoneNo

Input URL Syntax

The following is the URL to retrieve and renew all patron charged items:

The HTTP method for retrieving a charged item is GET. The HTTP method for renewing a charged item is POST.

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

The following is the URL to retrieve and renew a patron charged item:

The HTTP method for retrieving a charged item is GET. The HTTP method for renewing a charged item is POST.

http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@GWCCDB20010402131061%7C8465?patron_homedb=1@DMADB20010103091142

The following is the URL to retrieve patron charged items from a specific database:

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

The following is the URL to retrieve patron charged items with view=brief:

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

The following is the URL to retrieve patron charged items with view=full:

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

The following is the URL to retrieve patron charged items from a specific database:

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

The following is an example for renewing all of a user’s items.  Issue a POST:

http://10.100.3.87:61314/vxws/patron/152/circulationActions/loans?institution=1@LOCAL&patron_homedb=1@QA20012DB20020613131313

Output XML Format

The following is an output example of all patron charged items:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <loans>
    <institution id="LOCAL">
      <instName>DEV720DMADB</instName>
      <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@DMADB20010103091142|12511?patron_homedb=1@DMADB20010103091142" />
      <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@DMADB20010103091142|6325?patron_homedb=1@DMADB20010103091142" />
    </institution>
    <institution id="GWCC">
      <instName>ubgwcc720db</instName>
      <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@GWCCDB20010402131061|8465?patron_homedb=1@DMADB20010103091142" />
    </institution>
  </loans>
</response>

The following is an output example of a specific patron charged item:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <reply-text>ok</reply-text>
    <reply-code>0</reply-code>
    <resource>
          <loan>
              <itemId>8465</itemId>
              <itemBarcode>31004000154976</itemBarcode>
              <dueDate>2009-10-02 23:00</dueDate>
              <origDueDate>2009-09-02 23:00</origDueDate>
              <todaysDate>2009-12-09 09:57</todaysDate>
              <title>Introduction to comparative entomology [by] Richard M. Fox [and] Jean Walker Fox.</title>
              <author>Fox, Richard M. (Richard Middleton), 1911-1968.</author>
              <location>DWC-Stacks</location>
              <locationCode>DWC-Stacks</locationCode>
              <callNumber>QL463 .F69</callNumber>
              <statusCode>3</statusCode>
              <statusText>Renewed</statusText>
              <itemtype>book</itemtype>
              <dbKey>1@GWCCDB20010402131061</dbKey>
              <dbName>GWCC</dbName>
              <instName>ubgwcc720db</instName>
          </loan>
    </resource>
</response>

The following is an output example of patron charged items from a specific database:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
  <reply-text>ok</reply-text>
  <reply-code>0</reply-code>
  <loans>
      <institution id="GWCC">
          <instName>ubgwcc720db</instName>
          <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@GWCCDB20010402131061|8465?patron_homedb=1@DMADB20010103091142" />
      </institution>
  </loans>
</response>

The following is an output example of patron charged items with view=brief:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <reply-text>ok</reply-text>
    <reply-code>0</reply-code>
    <loans>
    <institution id="LOCAL">
        <instName>DEV720DMADB</instName>
        <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@DMADB20010103091142|3643?patron_homedb=1@DMADB20010103091142">
              <itemId>3643</itemId>
              <itemBarcode>31279000018609</itemBarcode>
              <dueDate>2009-12-18 23:00</dueDate>
              <title>Art of organic forms [by] Philip C. Ritterbush.</title>
              <author>Ritterbush, Philip C.</author>
              <location>Main Stacks</location>
              <locationCode>STACKS</locationCode>
              <statusCode>2</statusCode>
              <statusText>Charged</statusText>
              <dbKey>1@DMADB20010103091142</dbKey>
              <dbName>DEV720DMADB</dbName>
        </loan>
        <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@DMADB20010103091142|21?patron_homedb=1@DMADB20010103091142">
              <itemId>21</itemId>
              <itemBarcode>31279000180078</itemBarcode>
              <dueDate>2009-12-18 23:00</dueDate>
              <title>1986 ARTnews directory of corporate art collections / Shirley Reiff Howarth, editor.</title>
              <author xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" />
              <location>Reference Collection</location>
              <locationCode>REF</locationCode>
              <statusCode>2</statusCode>
              <statusText>Charged</statusText>
              <dbKey>1@DMADB20010103091142</dbKey>
              <dbName>DEV720DMADB</dbName>
          </loan>
        </institution>
        <institution id="GWCC">
          <instName>ubgwcc720db</instName>
          <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@GWCCDB20010402131061|8465?patron_homedb=1@DMADB20010103091142">
              <itemId>8465</itemId>
              <itemBarcode>31004000154976</itemBarcode>
              <dueDate>2009-10-02 23:00</dueDate>
              <title>Introduction to comparative entomology [by] Richard M. Fox [and] Jean Walker Fox.</title>
              <author>Fox, Richard M. (Richard Middleton), 1911-1968.</author>
              <location>DWC-Stacks</location>
              <locationCode>DWC-Stacks</locationCode>
              <statusCode>3</statusCode>
              <statusText>Renewed</statusText>
              <dbKey>1@GWCCDB20010402131061</dbKey>
              <dbName>ubgwcc720db</dbName>
          </loan>
         </institution>
    </loans>
</response>

The following is an output example of patron charged items with view=full:

<?xml version="1.0" encoding="UTF8" ?>
<response>
  <replytext>ok</replytext>
  <replycode>0</replycode>
  <loans>
     <institution id="LOCAL">
      <instName>DEV720DMADB</instName>
      <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@DMADB20010103091142|3643?patron_homedb=1@DMADB20010103091142">
          <itemId>3643</itemId>
          <itemBarcode>31279000018609</itemBarcode>
          <dueDate>20091218 23:00</dueDate>
          <origDueDate>20091218 23:00</origDueDate>
          <todaysDate>20091209 14:39</todaysDate>
          <title>Art of organic forms [by] Philip C. Ritterbush.</title>
          <author>Ritterbush, Philip C.</author>
          <location>Main Stacks</location>
          <locationCode>STACKS</locationCode>
          <callNumber>701.8 R514ar</callNumber>
          <statusCode>2</statusCode>
          <statusText>Charged</statusText>
          <itemtype>BOOK</itemtype>
          <dbKey>1@DMADB20010103091142</dbKey>
          <dbName>DEV720DMADB</dbName>
      </loan>
      <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@DMADB20010103091142|21?patron_homedb=1@DMADB20010103091142">
          <itemId>21</itemId>
          <itemBarcode>31279000180078</itemBarcode>
          <dueDate>20091218 23:00</dueDate>
          <origDueDate>20091218 23:00</origDueDate>
          <todaysDate>20091209 14:39</todaysDate>
          <title>1986 ARTnews directory of corporate art collections / Shirley Reiff Howarth, editor.</title>
          <author xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" />
          <location>Reference Collection</location>
          <locationCode>REF</locationCode>
          <callNumber>708.13 Ar78h</callNumber>
          <statusCode>2</statusCode>
          <statusText>Charged</statusText>
          <itemtype>BOOK</itemtype>
          <dbKey>1@DMADB20010103091142</dbKey>
          <dbName>DEV720DMADB</dbName>
      </loan>
    </institution>
    <institution id="GWCC">
      <instName>ubgwcc720db</instName>
     <loan href="http://10.100.2.37:30314/vxws/patron/204/circulationActions/loans/1@GWCCDB20010402131061|8465?patron_homedb=1@DMADB20010103091142">
          <itemId>8465</itemId>
          <itemBarcode>31004000154976</itemBarcode>
          <dueDate>20091002 23:00</dueDate>
          <origDueDate>20090902 23:00</origDueDate>
          <todaysDate>20091209 14:39</todaysDate>
          <title>Introduction to comparative entomology [by] Richard M. Fox [and] Jean Walker Fox.</title>
          <author>Fox, Richard M. (Richard Middleton), 19111968.</author>
          <location>DWCStacks</location>
          <locationCode>DWCStacks</locationCode>
          <callNumber>QL463 .F69</callNumber>
          <statusCode>3</statusCode>
          <statusText>Renewed</statusText>
          <itemtype>book</itemtype>
          <dbKey>1@GWCCDB20010402131061</dbKey>
          <dbName>ubgwcc720db</dbName>
      </loan>
    </institution>
  </loans>
</response>

The following is an output example of a successful renewal of all items:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <reply-text>ok</reply-text>
    <reply-code>0</reply-code>
    <renewal>
    <institution id="LOCAL">
        <instName>DEV720DMADB</instName>
        <loan loanid="1@DMADB20010103091142|3643">
            <itemId>3643</itemId>
            <itemBarcode>31279000018609</itemBarcode>
            <dueDate>2009-12-27 23:00</dueDate>
            <origDueDate>2009-12-18 23:00</origDueDate>
            <todaysDate>2009-12-09 14:44</todaysDate>
            <title>Art of organic forms [by] Philip C. Ritterbush. </title>
            <author>Ritterbush, Philip C. </author>
            <location>Main Stacks</location>
            <locationCode>STACKS</locationCode>
            <callNumber>701.8 R514ar</callNumber>
            <statusCode>3</statusCode>
            <statusText>Renewed</statusText>
            <itemtype>BOOK</itemtype>
            <dbKey>1@DMADB20010103091142</dbKey>
            <dbName>DEV720DMADB</dbName>
            <renewalStatus>Success</renewalStatus>
        </loan>
        <loan loanid="1@DMADB20010103091142|21">
            <itemId>21</itemId>
            <itemBarcode>31279000180078</itemBarcode>
            <dueDate>2009-12-27 23:00</dueDate>
            <origDueDate>2009-12-18 23:00</origDueDate>
            <todaysDate>2009-12-09 14:44</todaysDate>
            <title>1986 ARTnews directory of corporate art collections / Shirley Reiff Howarth, editor. </title>
            <author xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <location>Reference Collection</location><locationCode>REF</locationCode>
            <callNumber>708.13 Ar78h</callNumber>
            <statusCode>3</statusCode>
            <statusText>Renewed</statusText>
            <itemtype>BOOK</itemtype>
            <dbKey>1@DMADB20010103091142</dbKey>
            <dbName>DEV720DMADB</dbName>
            <renewalStatus>Success</renewalStatus>
        </loan>
    </institution>
    <institution id="GWCC">
        <instName>ubgwcc720db</instName>
        <loan loanid="1@GWCCDB20010402131061|8465">
            <itemId>8465</itemId>
            <itemBarcode>31004000154976</itemBarcode>
            <dueDate>2009-12-09 23:00</dueDate>
            <origDueDate>2009-09-02 23:00</origDueDate>
            <todaysDate>2009-12-09 14:44</todaysDate>
            <title>Introduction to comparative entomology [by] Richard M. Fox [and] Jean Walker Fox. </title>
            <author>Fox, Richard M. (Richard Middleton), 1911-1968. </author>
            <location>DWC-Stacks</location>
            <locationCode>DWC-Stacks</locationCode>
            <callNumber>QL463 .F69</callNumber>
            <statusCode>3</statusCode>
            <statusText>Renewed</statusText>
            <itemtype>book</itemtype>
            <dbKey>1@GWCCDB20010402131061</dbKey>
            <dbName>ubgwcc720db</dbName>
            <renewalStatus>Success</renewalStatus>
        </loan>
    </institution>
    </renewal>
</response>

The following is an output example of renewing of a specific loan:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <reply-text>ok</reply-text>
    <reply-code>0</reply-code>
    <renewal>
        <institution id="LOCAL">
            <instName>DEV720DMADB</instName>
            <loan loanid="1@DMADB20010103091142|6325">
                <itemId>6325</itemId><itemBarcode>31279000046311</itemBarcode>
                <dueDate>2009-12-27 23:00</dueDate>
                <origDueDate>2009-12-18 23:00</origDueDate>
                <todaysDate>2009-12-09 16:26</todaysDate>
                <title>Contemporary Spanish realists; [catalogue of an exhibition held] September-October 1973. </title>
                <author>Marlborough Fine Art (London) Ltd. </author>
                <location>Main Stacks</location>
                <locationCode>STACKS</locationCode>
                <callNumber>709.46 M343c1</callNumber>
                <statusCode>3</statusCode>
                <statusText>Renewed</statusText>
                <itemtype>BOOK</itemtype>
                <dbKey>1@DMADB20010103091142</dbKey>
                <dbName>DMA</dbName>
                <renewalStatus>Success</renewalStatus>
            </loan>
        </institution>
    </renewal>
</response>

The following is an output example of a failure of renewing a patron’s charged item:

The renewal status indicates what would have been the errors.

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <reply-text>ok</reply-text>
    <reply-code>0</reply-code>
    <renewal><institution id="LOCAL">
        <instName>DEV720DMADB</instName>
        <loan loanid="1@DMADB20010103091142|25069">
            <itemId>25069</itemId>
            <itemBarcode>31279000256431</itemBarcode>
            <dueDate>2009-08-10 23:00</dueDate>
            <origDueDate>2009-08-10 23:00</origDueDate>
            <todaysDate>2009-12-10 09:06</todaysDate>
            <title>Industrial design : reflection of a century / edited by Jocelyn de Noblet. </title>
            <author xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            <location>Main Stacks</location>
            <locationCode>STACKS</locationCode>
            <callNumber>T 183 .F8 D4713 1993</callNumber>
            <statusCode>14</statusCode>
            <statusText>Lost--System Applied</statusText>
            <itemtype>BOOK</itemtype>
            <dbKey>1@DMADB20010103091142</dbKey>
            <dbName>DMA</dbName>
            <renewalStatus>This item is not available for Call Slip requests., Maximum fines limit</renewalStatus>
        </loan>
        </institution>
    </renewal>
</response>

Possible Error Codes

2: The patron ID is not found
6: Loan does not exist
51: patron_homedb is a required parameter
52: dbkey is a required parameter