Ready to Learn?Ex Libris products all provide open APIs

Records per Patron

General Purpose

The resource may be accessed with a GET method to retrieve a specific patron's allowed actions on a given title.


Product Version Compatibility

Version 20.1 and later


Interface Type

RESTful API

 

Hierarchy

Slide18_patrons-patron_id-records

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

Record ID: The Aleph BIB record identifier. The identifier is composed of the BIB library code + the system number. For example, USM01000050362

URL Parameters:

institution: The ID of an institution (ADM library) for which the information is requested. The parameter may be used when the tab100 CONSORTIAL-HOLD-REQUEST variable is set to use institutional requests, or for defining the institution in which the short loan availability will be checked. Optional.

view: The full view may be used to expand the first available request type to include additional requesting information. Optional.


Input URI

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

For example:

To retrieve the available services list for the patron ID 00000036 and BIB record 000050362, use:

http://server.name:1892/rest-dlf/patron/00000036/record/USM01000050362

To retrieve the available services list for the patron ID 00000036 and BIB record 000050362 in a specific institution, use:

http://server.name:1892/rest-dlf/patron/00000036/record/USM01000050362?institution=USM50

To retrieve the available services list for the patron ID 00000036 and BIB record 000050362, and get full requesting information for the first available (default) request type, use:

http://server.name:1892/rest-dlf/patron/00000036/record/USM01000050362?view=full


Output XML Format

The returned XML includes a list of which request types the patron is allowed to place on the title.

For example:

<?xml version="1.0" encoding="UTF-8"?>
<rec-services>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <record>
    <info type="Items" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/items"/>
    <info type="HoldRequest" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/holds" allowed="Y"/>
    <info type="ShortLoan" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/shortLoan" allowed="N">
      <note type="error">This record does not have holdings which can be booked</note>
    </info>
    <info type="ILL" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/ill" allowed="Y"/>
    <info type="BookingRequest" allowed="Y">
      <bib-library>USM01</bib-library>
      <bib-doc-number>000009549</bib-doc-number>
    </info>
    <info type="AcquisitionRequest" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/acqRequest" allowed="N">
      <bib-library>USM01</bib-library>
      <bib-doc-number>000009549</bib-doc-number>
      <note type="error">You are not permitted to use this function.</note>
    </info>
  </record>
</rec-services>
Full view example:
<?xml version="1.0" encoding="UTF-8"?>
<rec-services>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <record>
    <info type="Items" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/items"/>
    <info type="HoldRequest" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/holds" allowed="Y">
      <hold allowed="Y">
        <institution code="USM50">
          <inst-name>Exlibris Demo Libraries</inst-name>
          <group href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/holds/USM50000009549000010">
            <translate-change-active-library>USM50</translate-change-active-library>
            <sublibrary-code>WID</sublibrary-code>
            <sublibrary>Main Library</sublibrary>
            <item-status-code>01</item-status-code>
            <item-status>Regular loan</item-status>
            <item-process-status-code/>
            <item-process-status>Not in Process</item-process-status>
            <collection-code>WIDLC</collection-code>
            <collection>WID-LC</collection>
            <volume/>
            <issue/>
            <part/>
            <year/>
            <month/>
            <material>Book</material>
            <description/>
            <pickup-locations default="Y" usage="Mandatory">
              <pickup-location code="LAW  ">Law Library</pickup-location>
              <pickup-location code="LIT  ">Economics Library</pickup-location>
            </pickup-locations>
          </group>
        </institution>
        <last-interest-date usage="Optional">20140306</last-interest-date>
        <start-interest-date usage="Optional"/>
        <sub-author usage="Optional" max_len="50"/>
        <sub-title usage="Optional" max_len="100"/>
        <pages usage="Optional" max_len="30"/>
        <note-1 usage="Optional" max_len="50"/>
        <note-2 usage="Optional" max_len="50"/>
        <rush usage="Optional"/>
      </hold>
    </info>
    <info type="ShortLoan" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/shortLoan" allowed="N">
      <note type="error">This record does not have holdings which can be booked</note>
    </info>
    <info type="ILL" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/ill" allowed="Y"/>
    <info type="BookingRequest" allowed="Y">
      <bib-library>USM01</bib-library>
      <bib-doc-number>000009549</bib-doc-number>
    </info>
    <info type="AcquisitionRequest" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000009549/acqRequest" allowed="N">
      <bib-library>USM01</bib-library>
      <bib-doc-number>000009549</bib-doc-number>
      <note type="error">You are not permitted to use this function.</note>
    </info>
  </record>
</rec-services>

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid

19 : Record does not exist