Ready to Learn?Ex Libris products all provide open APIs

Loans

Loans

General Purpose

The resource may be accessed with a GET method to retrieve a specific patron's loan information. The loan information may be retrieved as a patron's loan list, or as a specific loan's information. The loan list information is exported per institution (ADM library).

The resource may be retrieved with a POST method to renew a specific loan or the full loan list.

 

Product Version Compatibility

Versions 18, 20.1 and later

 

Interface Type

RESTful API

 

Hierarchy

 

Slide10_patrons-patron_id-circ_actions-loans

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

Loan ID: The ID of the specific loan that is requested. May be used to fetch a specific loan's information.

URL Parameters:

institution: The ID of an institution (ADM library) for which the information is requested. Optional.

type: The type of loan information that is requested. The value history is used to specify that loan history is requested. Optional.

view: The format in which the loans list will be displayed. Possible values are brief and full. Optional.

no_loans: The maximum number of historical loan records that the service returns. The default value of this parameter is 990.
Note that this parameter is relevant only when type = history.

noItems: (Aleph 22.1.6 and later, Aleph 23.1 and later) May be used to indicate the number of loans returned by the service. Possible values: number between 0 and 990. Optional.
If not all loans are returned the <partial> tag indicate Y. If all loans are returned, the <partial> tag indicate N.

startPos: (Aleph 22.1.6 and later, Aleph 23.1 and later) May be used to indicate the starting position of the loans list. Possible values: number, between 0 and 9999. Optional.

 

 

Input URI

Loans List:

<Base URL>:/patron/<patron ID>/circulationActions/loans?institution=<Institution ID>

For example:

To retrieve the loans list for the patron ID 00000036, use:

http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans

Use the same URL with a POST method to renew the full loans list.

To retrieve the loans history list for the patron ID 00000036, use:

http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans?type=history

To retrieve the loans list for the patron ID 00000036 for a specific institution, use:

http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans?institution=USM50

Use the same URL with a POST method to renew the institution's loans list.

To retrieve the loans list for the patron ID 00000036 in brief format, use:

http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans?view=brief

To retrieve the loans list for the patron ID 00000036 in full format, use:

http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans?view=full

Specific Loan:

<Base URL>:/patron/<patron ID>/circulationActions/loans/<loan ID>

For example:

To retrieve a specific loan's information for the patron ID 00000036, use:

http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans/USM50000009216

Use the same URL with a POST method to renew the specific loan.

 

Output XML Format

The returned XML includes the patron's loans lists per institution, or a specific loan's information. The information is exported as Z36/Z36H,Z30 and Z13 tags, in addition to a special fine tag that reports the loan's accrued fines. When setting the view parameter to full, the records are fully extracted. When setting the view parameter to brief, only some of the elements are extracted.

Note the renew attribute, which indicates whether or not the loan may be renewed in a POST action.

The list of institutes can be limited to those in which the patron is active, depending on the institute's setup of the FILTER-LIBRARY-CARD tab100 variable.

Loans list example:

<?xml version = "1.0" encoding = "UTF-8"?>
<pat-loan-list>
    <reply-text>ok</reply-text>
    <reply-code>0000</reply-code>
    <loans>
        <translate-change-active-library>USM50</translate-change-active-library>
        <institution code="USM50">
            <inst-name>Exlibris Demo Libraries</inst-name>
            <loan renew="Y" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans/USM50000008946">
                <z30-collection-code>MRS</z30-collection-code>
                <z30-item-status-code>01</z30-item-status-code>
                <z30-item-process-status-code/>
                <z30>
                    <translate-change-active-library>USM50</translate-change-active-library>
                    <z30-doc-number>000028166</z30-doc-number>
                    <z30-item-sequence>    1.0</z30-item-sequence>
                    <z30-barcode>32044047905369</z30-barcode>
                    <z30-sub-library>Humanities Library and Reading</z30-sub-library>
                    <z30-material>Visual material - Cassette</z30-material>
                    <z30-item-status>Regular loan</z30-item-status>
                    <z30-open-date>19970603</z30-open-date>
                    <z30-update-date>20020406</z30-update-date>
                    <z30-cataloger>CONV</z30-cataloger>
                    <z30-date-last-return>20060228</z30-date-last-return>
                    <z30-hour-last-return>1129</z30-hour-last-return>
                    <z30-ip-last-return>10.1.235.173</z30-ip-last-return>
                    <z30-no-loans>003</z30-no-loans>
                    <z30-alpha>L</z30-alpha>
                    <z30-collection>MRS</z30-collection>
                    <z30-call-no-type>8</z30-call-no-type>
                    <z30-call-no>VIDEO PN 1995.9 .W6 D64 1987x</z30-call-no>
                    <z30-call-no-key>8 $$hvideo$$ipn$$i1995.9$$i.w6$$id64$$i1987x</z30-call-no-key>
                    <z30-call-no-2-type/>
                    <z30-call-no-2/>
                    <z30-call-no-2-key/>
                    <z30-description/>
                    <z30-note-opac/>
                    <z30-note-circulation/>
                    <z30-note-internal/>
                    <z30-order-number/>
                    <z30-inventory-number/>
                    <z30-inventory-number-date>00000000</z30-inventory-number-date>
                    <z30-last-shelf-report-date>00000000</z30-last-shelf-report-date>
                    <z30-price/>
                    <z30-shelf-report-number/>
                    <z30-on-shelf-date>00000000</z30-on-shelf-date>
                    <z30-on-shelf-seq>000000</z30-on-shelf-seq>
                    <z30-doc-number-2>000028166</z30-doc-number-2>
                    <z30-schedule-sequence-2>00000</z30-schedule-sequence-2>
                    <z30-copy-sequence-2>00000</z30-copy-sequence-2>
                    <z30-vendor-code/>
                    <z30-invoice-number/>
                    <z30-line-number>00000</z30-line-number>
                    <z30-pages/>
                    <z30-issue-date>00000000</z30-issue-date>
                    <z30-expected-arrival-date>0</z30-expected-arrival-date>
                    <z30-arrival-date>0</z30-arrival-date>
                    <z30-item-statistic/>
                    <z30-item-process-status>Not in Process</z30-item-process-status>
                    <z30-copy-id/>
                    <z30-hol-doc-number>000049751</z30-hol-doc-number>
                    <z30-temp-location>No</z30-temp-location>
                    <z30-enumeration-a/>
                    <z30-enumeration-b/>
                    <z30-enumeration-c/>
                    <z30-enumeration-d/>
                    <z30-enumeration-e/>
                    <z30-enumeration-f/>
                    <z30-enumeration-g/>
                    <z30-enumeration-h/>
                    <z30-chronological-i/>
                    <z30-chronological-j/>
                    <z30-chronological-k/>
                    <z30-chronological-l/>
                    <z30-chronological-m/>
                    <z30-supp-index-o/>
                    <z30-85x-type/>
                    <z30-depository-id/>
                    <z30-linking-number>000000000</z30-linking-number>
                    <z30-gap-indicator/>
                    <z30-maintenance-count>001</z30-maintenance-count>
                    <z30-process-status-date>00000000</z30-process-status-date>
                    <z30-upd-time-stamp>200001011200000</z30-upd-time-stamp>
                    <z30-ip-last-return-v6/>
                </z30>
                <z36-sub-library-code>HILR</z36-sub-library-code>
                <z36-status-code>A</z36-status-code>
                <z36>
                    <translate-change-active-library>USM50</translate-change-active-library>
                    <z36-doc-number>000028166</z36-doc-number>
                    <z36-item-sequence>000010</z36-item-sequence>
                    <z36-id>00000036</z36-id>
                    <z36-number>000008946</z36-number>
                    <z36-material>VCASS</z36-material>
                    <z36-sub-library>Humanities Library and Reading</z36-sub-library>
                    <z36-status>Active</z36-status>
                    <z36-loan-date>20060228</z36-loan-date>
                    <z36-loan-hour>1129</z36-loan-hour>
                    <z36-effective-due-date>00000000</z36-effective-due-date>
                    <z36-due-date>20111001</z36-due-date>
                    <z36-due-hour>2400</z36-due-hour>
                    <z36-returned-date>00000000</z36-returned-date>
                    <z36-returned-hour>0000</z36-returned-hour>
                    <z36-item-status>01</z36-item-status>
                    <z36-bor-status>Faculty</z36-bor-status>
                    <z36-letter-number>1</z36-letter-number>
                    <z36-letter-date>20060811</z36-letter-date>
                    <z36-no-renewal>0</z36-no-renewal>
                    <z36-note-1/>
                    <z36-note-2/>
                    <z36-loan-cataloger-name>MASTER</z36-loan-cataloger-name>
                    <z36-loan-cataloger-ip>10.1.235.173</z36-loan-cataloger-ip>
                    <z36-return-cataloger-name/>
                    <z36-return-cataloger-ip/>
                    <z36-renew-cataloger-name/>
                    <z36-renew-cataloger-ip/>
                    <z36-renew-mode/>
                    <z36-bor-type/>
                    <z36-note-alpha/>
                    <z36-recall-date>00000000</z36-recall-date>
                    <z36-recall-due-date>00000000</z36-recall-due-date>
                    <z36-last-renew-date>00000000</z36-last-renew-date>
                    <z36-original-due-date>20060328</z36-original-due-date>
                    <z36-process-status/>
                    <z36-loan-type/>
                    <z36-proxy-id/>
                    <z36-recall-type/>
                    <z36-return-location/>
                    <z36-return-sub-location/>
                    <z36-source>Hold Request Loan</z36-source>
                    <z36-delivery-time/>
                    <z36-tail-time/>
                    <z36-upd-time-stamp>200001011200000</z36-upd-time-stamp>
                    <z36-loan-cataloger-ip-v6/>
                    <z36-return-cataloger-ip-v6/>
                    <z36-renew-cataloger-ip-v6/>
                </z36>
                <z13>
                    <translate-change-active-library>USM50</translate-change-active-library>
                    <z13-doc-number>000028166</z13-doc-number>
                    <z13-year>1987</z13-year>
                    <z13-open-date>20040307</z13-open-date>
                    <z13-update-date>20040307</z13-update-date>
                    <z13-call-no-key/>
                    <z13-call-no-code/>
                    <z13-call-no/>
                    <z13-author-code/>
                    <z13-author/>
                    <z13-title-code>24504</z13-title-code>
                    <z13-title>The Dollmaker</z13-title>
                    <z13-imprint-code>260</z13-imprint-code>
                    <z13-imprint>Livonia, Mich. : Playhouse Video, [1987]</z13-imprint>
                    <z13-isbn-issn-code/>
                    <z13-isbn-issn/>
                    <z13-upd-time-stamp>200001011200000</z13-upd-time-stamp>
                </z13>
                <fine>28.00</fine>
                <renew-info>0 (out of 5).No limit on latest due date.</renew-info>
            </loan>
            <partial>N</partial>
        </institution>
        <translate-change-active-library>USM51</translate-change-active-library>
        <institution code="USM51">
            <inst-name>USM51 Demo Libraries</inst-name>
            <loan renew="Y" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans/USM51000004046">
                <z30-collection-code>GEN</z30-collection-code>
                <z30-item-status-code>21</z30-item-status-code>
                <z30-item-process-status-code/>
                <z30>
                    <translate-change-active-library>USM51</translate-change-active-library>
                    <z30-doc-number>000052178</z30-doc-number>
                    <z30-item-sequence>    1.0</z30-item-sequence>
                    <z30-barcode>B578</z30-barcode>
                    <z30-sub-library>Education Library 51</z30-sub-library>
                    <z30-material>Book</z30-material>
                    <z30-item-status>Two Day Loan</z30-item-status>
                    <z30-open-date>20060212</z30-open-date>
                    <z30-update-date>00000000</z30-update-date>
                    <z30-cataloger>OCLCxfer</z30-cataloger>
                    <z30-date-last-return>00000000</z30-date-last-return>
                    <z30-hour-last-return>0000</z30-hour-last-return>
                    <z30-ip-last-return/>
                    <z30-no-loans>001</z30-no-loans>
                    <z30-alpha>L</z30-alpha>
                    <z30-collection>General</z30-collection>
                    <z30-call-no-type>0</z30-call-no-type>
                    <z30-call-no>PA5618 .I14T75</z30-call-no>
                    <z30-call-no-key> 0 pa5618 i14 t75</z30-call-no-key>
                    <z30-call-no-2-type/>
                    <z30-call-no-2/>
                    <z30-call-no-2-key/>
                    <z30-description/>
                    <z30-note-opac/>
                    <z30-note-circulation/>
                    <z30-note-internal/>
                    <z30-order-number/>
                    <z30-inventory-number/>
                    <z30-inventory-number-date>00000000</z30-inventory-number-date>
                    <z30-last-shelf-report-date>00000000</z30-last-shelf-report-date>
                    <z30-price/>
                    <z30-shelf-report-number/>
                    <z30-on-shelf-date>00000000</z30-on-shelf-date>
                    <z30-on-shelf-seq>000000</z30-on-shelf-seq>
                    <z30-doc-number-2>000000000</z30-doc-number-2>
                    <z30-schedule-sequence-2>00000</z30-schedule-sequence-2>
                    <z30-copy-sequence-2>00000</z30-copy-sequence-2>
                    <z30-vendor-code/>
                    <z30-invoice-number/>
                    <z30-line-number>00000</z30-line-number>
                    <z30-pages/>
                    <z30-issue-date>00000000</z30-issue-date>
                    <z30-expected-arrival-date>0</z30-expected-arrival-date>
                    <z30-arrival-date>0</z30-arrival-date>
                    <z30-item-statistic/>
                    <z30-item-process-status/>
                    <z30-copy-id/>
                    <z30-hol-doc-number>000050057</z30-hol-doc-number>
                    <z30-temp-location>No</z30-temp-location>
                    <z30-enumeration-a/>
                    <z30-enumeration-b/>
                    <z30-enumeration-c/>
                    <z30-enumeration-d/>
                    <z30-enumeration-e/>
                    <z30-enumeration-f/>
                    <z30-enumeration-g/>
                    <z30-enumeration-h/>
                    <z30-chronological-i/>
                    <z30-chronological-j/>
                    <z30-chronological-k/>
                    <z30-chronological-l/>
                    <z30-chronological-m/>
                    <z30-supp-index-o/>
                    <z30-85x-type/>
                    <z30-depository-id/>
                    <z30-linking-number>000000000</z30-linking-number>
                    <z30-gap-indicator/>
                    <z30-maintenance-count>001</z30-maintenance-count>
                    <z30-process-status-date>00000000</z30-process-status-date>
                    <z30-upd-time-stamp>200001011200000</z30-upd-time-stamp>
                    <z30-ip-last-return-v6/>
                </z30>
                <z36-sub-library-code>EDUC5</z36-sub-library-code>
                <z36-status-code>A</z36-status-code>
                <z36>
                    <translate-change-active-library>USM51</translate-change-active-library>
                    <z36-doc-number>000052178</z36-doc-number>
                    <z36-item-sequence>000010</z36-item-sequence>
                    <z36-id>00000036</z36-id>
                    <z36-number>000004046</z36-number>
                    <z36-material>BOOK</z36-material>
                    <z36-sub-library>Education Library 51</z36-sub-library>
                    <z36-status>Active</z36-status>
                    <z36-loan-date>20060221</z36-loan-date>
                    <z36-loan-hour>1421</z36-loan-hour>
                    <z36-effective-due-date>00000000</z36-effective-due-date>
                    <z36-due-date>20111001</z36-due-date>
                    <z36-due-hour>2359</z36-due-hour>
                    <z36-returned-date>00000000</z36-returned-date>
                    <z36-returned-hour>0000</z36-returned-hour>
                    <z36-item-status>21</z36-item-status>
                    <z36-bor-status>Undergrad</z36-bor-status>
                    <z36-letter-number>0</z36-letter-number>
                    <z36-letter-date>00000000</z36-letter-date>
                    <z36-no-renewal>0</z36-no-renewal>
                    <z36-note-1/>
                    <z36-note-2/>
                    <z36-loan-cataloger-name>USM50</z36-loan-cataloger-name>
                    <z36-loan-cataloger-ip>10.1.235.173</z36-loan-cataloger-ip>
                    <z36-return-cataloger-name/>
                    <z36-return-cataloger-ip/>
                    <z36-renew-cataloger-name/>
                    <z36-renew-cataloger-ip/>
                    <z36-renew-mode/>
                    <z36-bor-type/>
                    <z36-note-alpha/>
                    <z36-recall-date>00000000</z36-recall-date>
                    <z36-recall-due-date>00000000</z36-recall-due-date>
                    <z36-last-renew-date>00000000</z36-last-renew-date>
                    <z36-original-due-date>20060223</z36-original-due-date>
                    <z36-process-status/>
                    <z36-loan-type/>
                    <z36-proxy-id/>
                    <z36-recall-type/>
                    <z36-return-location/>
                    <z36-return-sub-location/>
                    <z36-source/>
                    <z36-delivery-time/>
                    <z36-tail-time/>
                    <z36-upd-time-stamp>200001011200000</z36-upd-time-stamp>
                    <z36-loan-cataloger-ip-v6/>
                    <z36-return-cataloger-ip-v6/>
                    <z36-renew-cataloger-ip-v6/>
                </z36>
                <z13>
                    <translate-change-active-library>USM51</translate-change-active-library>
                    <z13-doc-number>000050106</z13-doc-number>
                    <z13-year>0000</z13-year>
                    <z13-open-date>00000000</z13-open-date>
                    <z13-update-date>00000000</z13-update-date>
                    <z13-call-no-key/>
                    <z13-call-no-code/>
                    <z13-call-no/>
                    <z13-author-code/>
                    <z13-author/>
                    <z13-title-code/>
                    <z13-title/>
                    <z13-imprint-code/>
                    <z13-imprint/>
                    <z13-isbn-issn-code/>
                    <z13-isbn-issn/>
                    <z13-upd-time-stamp>000000000000000</z13-upd-time-stamp>
                </z13>
                <fine/>
                <renew-info>0 (out of 1).Latest due date is 03/01/14.</renew-info>
            </loan>
            <loan renew="Y" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans/USM51000004047">
                <z30-collection-code>GEN</z30-collection-code>
                <z30-item-status-code>21</z30-item-status-code>
                <z30-item-process-status-code/>
                <z30>
                    <translate-change-active-library>USM51</translate-change-active-library>
                    <z30-doc-number>000050702</z30-doc-number>
                    <z30-item-sequence>    2.0</z30-item-sequence>
                    <z30-barcode>B285</z30-barcode>
                    <z30-sub-library>Lincoln Library 51</z30-sub-library>
                    <z30-material>Book</z30-material>
                    <z30-item-status>Two Day Loan</z30-item-status>
                    <z30-open-date>20050105</z30-open-date>
                    <z30-update-date>00000000</z30-update-date>
                    <z30-cataloger>MARCIVE</z30-cataloger>
                    <z30-date-last-return>00000000</z30-date-last-return>
                    <z30-hour-last-return>0000</z30-hour-last-return>
                    <z30-ip-last-return/>
                    <z30-no-loans>001</z30-no-loans>
                    <z30-alpha>L</z30-alpha>
                    <z30-collection>General</z30-collection>
                    <z30-call-no-type>1</z30-call-no-type>
                    <z30-call-no>155.2/5</z30-call-no>
                    <z30-call-no-key>1 $$h155 2/5</z30-call-no-key>
                    <z30-call-no-2-type/>
                    <z30-call-no-2/>
                    <z30-call-no-2-key/>
                    <z30-description/>
                    <z30-note-opac/>
                    <z30-note-circulation/>
                    <z30-note-internal/>
                    <z30-order-number/>
                    <z30-inventory-number/>
                    <z30-inventory-number-date>00000000</z30-inventory-number-date>
                    <z30-last-shelf-report-date>00000000</z30-last-shelf-report-date>
                    <z30-price/>
                    <z30-shelf-report-number/>
                    <z30-on-shelf-date>00000000</z30-on-shelf-date>
                    <z30-on-shelf-seq>000000</z30-on-shelf-seq>
                    <z30-doc-number-2>000000000</z30-doc-number-2>
                    <z30-schedule-sequence-2>00000</z30-schedule-sequence-2>
                    <z30-copy-sequence-2>00000</z30-copy-sequence-2>
                    <z30-vendor-code/>
                    <z30-invoice-number/>
                    <z30-line-number>00000</z30-line-number>
                    <z30-pages/>
                    <z30-issue-date>00000000</z30-issue-date>
                    <z30-expected-arrival-date>0</z30-expected-arrival-date>
                    <z30-arrival-date>0</z30-arrival-date>
                    <z30-item-statistic/>
                    <z30-item-process-status/>
                    <z30-copy-id/>
                    <z30-hol-doc-number>000050623</z30-hol-doc-number>
                    <z30-temp-location>No</z30-temp-location>
                    <z30-enumeration-a/>
                    <z30-enumeration-b/>
                    <z30-enumeration-c/>
                    <z30-enumeration-d/>
                    <z30-enumeration-e/>
                    <z30-enumeration-f/>
                    <z30-enumeration-g/>
                    <z30-enumeration-h/>
                    <z30-chronological-i/>
                    <z30-chronological-j/>
                    <z30-chronological-k/>
                    <z30-chronological-l/>
                    <z30-chronological-m/>
                    <z30-supp-index-o/>
                    <z30-85x-type/>
                    <z30-depository-id/>
                    <z30-linking-number>000000000</z30-linking-number>
                    <z30-gap-indicator/>
                    <z30-maintenance-count>001</z30-maintenance-count>
                    <z30-process-status-date>00000000</z30-process-status-date>
                    <z30-upd-time-stamp>200001011200000</z30-upd-time-stamp>
                    <z30-ip-last-return-v6/>
                </z30>
                <z36-sub-library-code>LINC5</z36-sub-library-code>
                <z36-status-code>A</z36-status-code>
                <z36>
                    <translate-change-active-library>USM51</translate-change-active-library>
                    <z36-doc-number>000050702</z36-doc-number>
                    <z36-item-sequence>000020</z36-item-sequence>
                    <z36-id>00000036</z36-id>
                    <z36-number>000004047</z36-number>
                    <z36-material>BOOK</z36-material>
                    <z36-sub-library>Lincoln Library 51</z36-sub-library>
                    <z36-status>Active</z36-status>
                    <z36-loan-date>20060221</z36-loan-date>
                    <z36-loan-hour>1422</z36-loan-hour>
                    <z36-effective-due-date>00000000</z36-effective-due-date>
                    <z36-due-date>20111001</z36-due-date>
                    <z36-due-hour>2359</z36-due-hour>
                    <z36-returned-date>00000000</z36-returned-date>
                    <z36-returned-hour>0000</z36-returned-hour>
                    <z36-item-status>21</z36-item-status>
                    <z36-bor-status>Undergrad</z36-bor-status>
                    <z36-letter-number>0</z36-letter-number>
                    <z36-letter-date>00000000</z36-letter-date>
                    <z36-no-renewal>0</z36-no-renewal>
                    <z36-note-1/>
                    <z36-note-2/>
                    <z36-loan-cataloger-name>USM50</z36-loan-cataloger-name>
                    <z36-loan-cataloger-ip>10.1.235.173</z36-loan-cataloger-ip>
                    <z36-return-cataloger-name/>
                    <z36-return-cataloger-ip/>
                    <z36-renew-cataloger-name/>
                    <z36-renew-cataloger-ip/>
                    <z36-renew-mode/>
                    <z36-bor-type/>
                    <z36-note-alpha/>
                    <z36-recall-date>00000000</z36-recall-date>
                    <z36-recall-due-date>00000000</z36-recall-due-date>
                    <z36-last-renew-date>00000000</z36-last-renew-date>
                    <z36-original-due-date>20060223</z36-original-due-date>
                    <z36-process-status/>
                    <z36-loan-type/>
                    <z36-proxy-id/>
                    <z36-recall-type/>
                    <z36-return-location/>
                    <z36-return-sub-location/>
                    <z36-source/>
                    <z36-delivery-time/>
                    <z36-tail-time/>
                    <z36-upd-time-stamp>200001011200000</z36-upd-time-stamp>
                    <z36-loan-cataloger-ip-v6/>
                    <z36-return-cataloger-ip-v6/>
                    <z36-renew-cataloger-ip-v6/>
                </z36>
                <z13>
                    <translate-change-active-library>USM51</translate-change-active-library>
                    <z13-doc-number>000050702</z13-doc-number>
                    <z13-year>0000</z13-year>
                    <z13-open-date>00000000</z13-open-date>
                    <z13-update-date>00000000</z13-update-date>
                    <z13-call-no-key/>
                    <z13-call-no-code/>
                    <z13-call-no/>
                    <z13-author-code/>
                    <z13-author/>
                    <z13-title-code/>
                    <z13-title/>
                    <z13-imprint-code/>
                    <z13-imprint/>
                    <z13-isbn-issn-code/>
                    <z13-isbn-issn/>
                    <z13-upd-time-stamp>000000000000000</z13-upd-time-stamp>
                </z13>
                <fine/>
                <renew-info>0 (out of 1).Latest due date is 03/01/14.</renew-info>
            </loan>
            <partial>N</partial>
        </institution>
        <translate-change-active-library>MAB50</translate-change-active-library>
        <institution code="MAB50">
            <inst-name>MAB Demo Library</inst-name>
        </institution>
    </loans>
</pat-loan-list>

 

The "<partial>" tag (Aleph 22.1.6 and later, Aleph 23.1 and later): If not all loans are returned the <partial> tag indicate Y. If all loans are returned, the <partial> tag indicate N.

 

Specific loan example:

 

 

 

<?xml version="1.0" encoding="UTF-8"?>
<get-pat-loan>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <loan renew="Y">
    <z30-collection-code>MRS</z30-collection-code>
    <z30-item-status-code>01</z30-item-status-code>
    <z30-item-process-status-code/>
    <z30>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z30-doc-number>000028166</z30-doc-number>
      <z30-item-sequence>    1.0</z30-item-sequence>
      <z30-barcode>32044047905369</z30-barcode>
      <z30-sub-library>Humanities Library and Reading</z30-sub-library>
      <z30-material>Visual material - Cassette</z30-material>
      <z30-item-status>Regular loan</z30-item-status>
      <z30-open-date>19970603</z30-open-date>
      <z30-update-date>20020406</z30-update-date>
      <z30-cataloger>CONV</z30-cataloger>
      <z30-date-last-return>20060228</z30-date-last-return>
      <z30-hour-last-return>1129</z30-hour-last-return>
      <z30-ip-last-return>10.1.235.173</z30-ip-last-return>
      <z30-no-loans>003</z30-no-loans>
      <z30-alpha>L</z30-alpha>
      <z30-collection>MRS</z30-collection>
      <z30-call-no-type>8</z30-call-no-type>
      <z30-call-no>VIDEO PN 1995.9 .W6 D64 1987x</z30-call-no>
      <z30-call-no-key>8 $$hvideo$$ipn$$i1995.9$$i.w6$$id64$$i1987x</z30-call-no-key>
      <z30-call-no-2-type/>
      <z30-call-no-2/>
      <z30-call-no-2-key/>
      <z30-description/>
      <z30-note-opac/>
      <z30-note-circulation/>
      <z30-note-internal/>
      <z30-order-number/>
      <z30-inventory-number/>
      <z30-inventory-number-date>00000000</z30-inventory-number-date>
      <z30-last-shelf-report-date>00000000</z30-last-shelf-report-date>
      <z30-price/>
      <z30-shelf-report-number/>
      <z30-on-shelf-date>00000000</z30-on-shelf-date>
      <z30-on-shelf-seq>000000</z30-on-shelf-seq>
      <z30-doc-number-2>000028166</z30-doc-number-2>
      <z30-schedule-sequence-2>00000</z30-schedule-sequence-2>
      <z30-copy-sequence-2>00000</z30-copy-sequence-2>
      <z30-vendor-code/>
      <z30-invoice-number/>
      <z30-line-number>00000</z30-line-number>
      <z30-pages/>
      <z30-issue-date>00000000</z30-issue-date>
      <z30-expected-arrival-date>0</z30-expected-arrival-date>
      <z30-arrival-date>0</z30-arrival-date>
      <z30-item-statistic/>
      <z30-item-process-status>Not in Process</z30-item-process-status>
      <z30-copy-id/>
      <z30-hol-doc-number>000049751</z30-hol-doc-number>
      <z30-temp-location>No</z30-temp-location>
      <z30-enumeration-a/>
      <z30-enumeration-b/>
      <z30-enumeration-c/>
      <z30-enumeration-d/>
      <z30-enumeration-e/>
      <z30-enumeration-f/>
      <z30-enumeration-g/>
      <z30-enumeration-h/>
      <z30-chronological-i/>
      <z30-chronological-j/>
      <z30-chronological-k/>
      <z30-chronological-l/>
      <z30-chronological-m/>
      <z30-supp-index-o/>
      <z30-85x-type/>
      <z30-depository-id/>
      <z30-linking-number>000000000</z30-linking-number>
      <z30-gap-indicator/>
      <z30-maintenance-count>001</z30-maintenance-count>
      <z30-process-status-date>00000000</z30-process-status-date>
      <z30-upd-time-stamp>200001011200000</z30-upd-time-stamp>
      <z30-ip-last-return-v6/>
    </z30>
    <z36-sub-library-code>HILR</z36-sub-library-code>
    <z36-status-code>A</z36-status-code>
    <z36>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z36-doc-number>000028166</z36-doc-number>
      <z36-item-sequence>000010</z36-item-sequence>
      <z36-id>00000036</z36-id>
      <z36-number>000008946</z36-number>
      <z36-material>VCASS</z36-material>
      <z36-sub-library>Humanities Library and Reading</z36-sub-library>
      <z36-status>Active</z36-status>
      <z36-loan-date>20060228</z36-loan-date>
      <z36-loan-hour>1129</z36-loan-hour>
      <z36-effective-due-date>00000000</z36-effective-due-date>
      <z36-due-date>20111001</z36-due-date>
      <z36-due-hour>2400</z36-due-hour>
      <z36-returned-date>00000000</z36-returned-date>
      <z36-returned-hour>0000</z36-returned-hour>
      <z36-item-status>01</z36-item-status>
      <z36-bor-status>Faculty</z36-bor-status>
      <z36-letter-number>1</z36-letter-number>
      <z36-letter-date>20060811</z36-letter-date>
      <z36-no-renewal>0</z36-no-renewal>
      <z36-note-1/>
      <z36-note-2/>
      <z36-loan-cataloger-name>MASTER</z36-loan-cataloger-name>
      <z36-loan-cataloger-ip>10.1.235.173</z36-loan-cataloger-ip>
      <z36-return-cataloger-name/>
      <z36-return-cataloger-ip/>
      <z36-renew-cataloger-name/>
      <z36-renew-cataloger-ip/>
      <z36-renew-mode/>
      <z36-bor-type/>
      <z36-note-alpha/>
      <z36-recall-date>00000000</z36-recall-date>
      <z36-recall-due-date>00000000</z36-recall-due-date>
      <z36-last-renew-date>00000000</z36-last-renew-date>
      <z36-original-due-date>20060328</z36-original-due-date>
      <z36-process-status/>
      <z36-loan-type/>
      <z36-proxy-id/>
      <z36-recall-type/>
      <z36-return-location/>
      <z36-return-sub-location/>
      <z36-source>Hold Request Loan</z36-source>
      <z36-delivery-time/>
      <z36-tail-time/>
      <z36-upd-time-stamp>200001011200000</z36-upd-time-stamp>
      <z36-loan-cataloger-ip-v6/>
      <z36-return-cataloger-ip-v6/>
      <z36-renew-cataloger-ip-v6/>
    </z36>
    <z13>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z13-doc-number>000028166</z13-doc-number>
      <z13-year>1987</z13-year>
      <z13-open-date>20040307</z13-open-date>
      <z13-update-date>20040307</z13-update-date>
      <z13-call-no-key/>
      <z13-call-no-code/>
      <z13-call-no/>
      <z13-author-code/>
      <z13-author/>
      <z13-title-code>24504</z13-title-code>
      <z13-title>The Dollmaker</z13-title>
      <z13-imprint-code>260</z13-imprint-code>
      <z13-imprint>Livonia, Mich. : Playhouse Video, [1987]</z13-imprint>
      <z13-isbn-issn-code/>
      <z13-isbn-issn/>
      <z13-upd-time-stamp>200001011200000</z13-upd-time-stamp>
    </z13>
    <fine>28.00</fine>
    <renew-info>0 (out of 5).No limit on latest due date.</renew-info>
  </loan>
</get-pat-loan>

 

 

 Renew action - Example input for the HTTP request body, using 'POST' method:

<?xml version = "1.0" encoding = "UTF-8"?>
<get-pat-loan>
    <loan renew="Y">
        <z30-collection-code>MRS</z30-collection-code>
        <z30-item-status-code>01</z30-item-status-code>
        <z36-sub-library-code>HILR</z36-sub-library-code>
        <z36>
            <translate-change-active-library>USM50</translate-change-active-library>
            <z36-doc-number>000028166</z36-doc-number>
            <z36-item-sequence>000010</z36-item-sequence>
            <z36-id>1930</z36-id>
            <z36-number>000008946</z36-number>
        </z36>
    </loan>
</get-pat-loan>

Renew action response example:

<?xml version="1.0" encoding="UTF-8"?>
<renew-loan>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <renewals>
    <institution code="USM50">
      <inst-name>Exlibris Demo Libraries</inst-name>
      <inst-status code="0000">OK</inst-status>
      <loan id="USM50000008946">
        <new-due-date>20140130</new-due-date>
        <new-due-hour>2359</new-due-hour>
        <status>Renew successful</status>
      </loan>
    </institution>
  </renewals>
</renew-loan>

Renew action response example - version 22.1.6 / 23.1.0 and later:
The "<status-code>" tag indicates whether a specific renewal succeeded or not.

Possible values: Y/N
Y - not all of the loans are returned in the output result list.
N - The full list of loans are listed in the returned list.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<renew-loan>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <renewals>
    <institution code="USM50">
      <inst-name>Exlibris Demo Libraries</inst-name>
      <inst-status code="0000">OK</inst-status>
      <loan id="USM50000008946">
        <new-due-date>20140130</new-due-date>
        <new-due-hour>2359</new-due-hour>
        <status>Renew successful</status>
     <status-code>Y</status-code>
      </loan>
    </institution>
  </renewals>
</renew-loan>

 

 Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid

03 : Loan does not belong to the requested patron

06 : Loan does not exist

28 : Renew failed