ILL

General Purpose

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

The resource may be accessed with a POST method to renew a specific ILL request.

The resource may be accessed with a DELETE method to cancel a specific ILL request.

Note that in version 18 old ILL and web ILL are not supported.

Product Version Compatibility

Versions 18, 20.1 and later

Interface Type

RESTful API

Hierarchy

Patron ILL requests

 

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

ILL ID: The ID of the specific ILL request that is requested. May be used to fetch a specific ILL request’s information.

URL Parameters:

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

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

type: The ststus of the ILL requests that will be displayed in the list. Possible value is active which means that only active (not closed) requests will be displayed. Optional.

Input URI

ILL Requests List:

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

For example:

To retrieve the ILL requests list for the patron ID 00000036, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill

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

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill?institution=USM50

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

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill?view=brief

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

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill?view=full

To retrieve the ILL requests list for the patron ID 00000036 for active requests only (excluding closed, unfilled, cancelled, deleted, expired and returned by patron or by library), use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill?type=active

Specific ILL Request:

<Base URL>:/patron/<patron ID>/circulationActions/requests/ill/<ILL ID>_

For example:

To retrieve a specific ILL request’s information for the patron ID 00000036, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000001094

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

Use the same URL with a DELETE method to cancel a specific ILL request.

Output XML Format

The returned XML includes the patron’s ILL request lists per institution, or a specific ILL request’s information. The information is exported as Z410, Z411, Z36 and Z13\Z13U tags, in addition to the following special tags:

  • suppliers-status : A list of the request’s potential suppliers and their status.
  • title-of-article : The request’s title of article when defined.
  • author-of-article : The request’s author of article when defined.
  • title-imprint : Imprint information of the ILL request.
  • notes-to-patron : Information on letters that were sent to the patron regarding the ILL request.

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 cancel attribute, which indicates whether or not the request may be cancelled in a DELETE action.

Note the renew attribute, which indicates whether or not the request 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.

ILL request list example:

<?xml version="1.0" encoding="UTF-8"?>
<pat-ill-list>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <ill-requests>
    <translate-change-active-library>USM50</translate-change-active-library>
    <institution code="USM50">
      <inst-name>Exlibris Demo Libraries</inst-name>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000346"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000351"/>
      <ill-request cancel="Y" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000058"/>
      <ill-request cancel="Y" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000064"/>
      <ill-request cancel="Y" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000071"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000347"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000344"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000325"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000327"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000329"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000332"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000334"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000336"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000339"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000341"/>
      <ill-request cancel="Y" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000321"/>
      <ill-request cancel="Y" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000323"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000320"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000128"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000173"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000277"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000116"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000273"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000276"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000279"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000280"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000077"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000172"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000274"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000283"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000284"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000078"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000171"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000052"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000121"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000129"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000118"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000124"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000136"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000110"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000048"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000043"/>
      <ill-request cancel="N" renew="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill/USM40000000047"/>
    </institution>
  </ill-requests>
</pat-ill-list>

Specific ILL request example:

<?xml version="1.0" encoding="UTF-8"?>
<get-pat-ill>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <ill-request cancel="N" renew="N">
    <z410>
      <translate-change-active-library>USM40</translate-change-active-library>
      <z410-doc-number>000000346</z410-doc-number>
      <z410-id>00000036</z410-id>
      <z410-staff-initiated/>
      <z410-z411-sequence>000000001</z410-z411-sequence>
      <z410-ill-unit>ILL_LAW</z410-ill-unit>
      <z410-willing-to-pay>No</z410-willing-to-pay>
      <z410-circ-send-action/>
      <z410-pickup-location>Law Library</z410-pickup-location>
      <z410-status>Closed</z410-status>
      <z410-patron-note/>
      <z410-staff-note/>
      <z410-open-date>20060606</z410-open-date>
      <z410-update-date>20070516</z410-update-date>
      <z410-last-interest-date>20070606</z410-last-interest-date>
      <z410-media>Printed (Loan)</z410-media>
      <z410-lng>English</z410-lng>
      <z410-level-of-service>When convenient</z410-level-of-service>
      <z410-copyright-letter>No</z410-copyright-letter>
      <z410-send-direct>No</z410-send-direct>
      <z410-media-send-method>S</z410-media-send-method>
      <z410-media-send-info/>
      <z410-archive>N</z410-archive>
    </z410>
    <translate-change-active-library>USM40</translate-change-active-library>
    <suppliers-status>CA</suppliers-status>
    <z411>
      <translate-change-active-library>USM40</translate-change-active-library>
      <z411-doc-number>000000346</z411-doc-number>
      <z411-sequence>000000001</z411-sequence>
      <z411-partner-code>ILL_HYL</z411-partner-code>
      <z411-system-number/>
      <z411-shelving/>
      <z411-note-to-partner/>
      <z411-letter-type>General letter</z411-letter-type>
      <z411-request-protocol-type/>
      <z411-send-method/>
      <z411-requested-media>Printed (Loan)</z411-requested-media>
      <z411-request-send-date>20061004</z411-request-send-date>
      <z411-request-send-time>095506</z411-request-send-time>
      <z411-status>Cancelled</z411-status>
      <z411-status-date>20061004</z411-status-date>
      <z411-open-date>20061004</z411-open-date>
      <z411-update-date>20061004</z411-update-date>
      <z411-expected-arrival-date>20061006</z411-expected-arrival-date>
      <z411-supp-media>Printed (Loan)</z411-supp-media>
      <z411-arrival-date>00000000</z411-arrival-date>
      <z411-circulation-note/>
      <z411-expected-return-date>00000000</z411-expected-return-date>
      <z411-return-date>00000000</z411-return-date>
      <z411-pages>000</z411-pages>
      <z411-page-size/>
      <z411-e-currency>Israel New Shekel</z411-e-currency>
      <z411-e-price>0.00</z411-e-price>
      <z411-e-local-price>0.00</z411-e-local-price>
      <z411-s-currency/>
      <z411-s-price>0.00</z411-s-price>
      <z411-s-local-price>0.00</z411-s-local-price>
      <z411-patron-currency/>
      <z411-patron-price>0.00</z411-patron-price>
      <z411-patron-local-price>0.00</z411-patron-local-price>
      <z411-copyright-compliant/>
      <z411-copyright-currency/>
      <z411-copyright-price>0.00</z411-copyright-price>
      <z411-copyright-local-price>0.00</z411-copyright-local-price>
      <z411-circ-doc-number>000000000</z411-circ-doc-number>
      <z411-circ-item-sequence>0</z411-circ-item-sequence>
      <z411-item-barcode/>
      <z411-customer-id/>
      <z411-reference-number/>
      <z411-require-user-agreement/>
      <z411-cataloger>AUTO</z411-cataloger>
      <z411-agreement-blocking/>
      <z411-agreement-signed/>
      <z411-reapply-date>00000000</z411-reapply-date>
      <z411-s-budget-number/>
      <z411-cr-budget-number/>
      <z411-bl-keywords1/>
      <z411-bl-keywords2/>
      <z411-media-send-method>S</z411-media-send-method>
      <z411-request-number-1/>
      <z411-avg-supply-days>3</z411-avg-supply-days>
      <z411-expiry-days>6</z411-expiry-days>
      <z411-delivery-delay>2</z411-delivery-delay>
      <z411-requester-system-id>EXL-LAW</z411-requester-system-id>
      <z411-group-qualifier>000000346</z411-group-qualifier>
      <z411-qualifier>000000001</z411-qualifier>
    </z411>
    <z13>
      <translate-change-active-library>USM40</translate-change-active-library>
      <z13-doc-number>000000346</z13-doc-number>
      <z13-year>1922</z13-year>
      <z13-open-date>20040307</z13-open-date>
      <z13-update-date>20060606</z13-update-date>
      <z13-call-no-key/>
      <z13-call-no-code/>
      <z13-call-no/>
      <z13-author-code/>
      <z13-author/>
      <z13-title-code>24502</z13-title-code>
      <z13-title>A short outline of the history of the Far Eastern Republic.</z13-title>
      <z13-imprint-code>260</z13-imprint-code>
      <z13-imprint>Washington, D.C. :.</z13-imprint>
      <z13-isbn-issn-code/>
      <z13-isbn-issn/>
      <z13-upd-time-stamp>200001011200000</z13-upd-time-stamp>
    </z13>
    <translate-change-active-library>USM40</translate-change-active-library>
    <title-of-article/>
    <author-of-article/>
    <title-imprint>Washington, D.C. :.</title-imprint>
    <z13u-additional-bib-info-1/>
    <z13u-additional-bib-info-2/>
    <z13u-additional-bib-info-3/>
    <z13u-additional-bib-info-4/>
    <z13u-additional-bib-info-5/>
  </ill-request>
</get-pat-ill>

Specific ILL renewal example:

<?xml version="1.0" encoding="UTF-8"?>
<renew-ill>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <note type="info">Action Succeeded</note>
</renew-ill>

Specific ILL cancel example:

<?xml version="1.0" encoding="UTF-8"?>
<del-pat-ill>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <note type="info">Action Succeeded</note>
</del-pat-ill>

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid

05 : Request does not belong to the requested patron

08 : Request does not exist

13 : Request cancellation failed

16 : Renew not allowed

18 : Failed to send renew message