Ready to Learn?Ex Libris products all provide open APIs

Patrons

General Purpose

Retrieves sub-resources of the Patrons resource and a list of institutes in which the patron is active.

Product Version Compatibility

Versions 18, 20.1 and later


Interface Type

RESTful API

 

Hierarchy

Slide5_patrons-patron_id

Input Parameters

Patron ID: The Aleph patron system identifier


Input URI

<BaseURL>:/patron/<patron ID>

For example: To retrieve the sub-resources for the patron ID 00000036, use:

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


Output XML Format

The returned XML includes links to the patron's sub-resources, as well as a list of the patron's institutes (ADM libraries). 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.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<get-patron>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <patron>
    <info type="Circulation Actions" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions"/>
    <info type="Patron Information" href="http://server.name:1893/rest-dlf/patron/00000036/patronInformation"/>
    <info type="Patron Status" href="http://server.name:1893/rest-dlf/patron/00000036/patronStatus"/>
    <info type="Records" href="http://server.name:1893/rest-dlf/patron/00000036/record"/>
    <info type="Acq Request" href="http://server.name:1893/rest-dlf/patron/00000036/acqRequest"/>
    <translate-change-active-library>USM50</translate-change-active-library>
    <institution code="USM50">Exlibris Demo Libraries</institution>
    <translate-change-active-library>USM51</translate-change-active-library>
    <institution code="USM51">USM51 Demo Libraries</institution>
    <translate-change-active-library>MAB50</translate-change-active-library>
    <institution code="MAB50">MAB Demo Library</institution>
  </patron>
</get-patron>

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid