Patron Status

General Purpose

Retrieves sub-resources of the Patron Status resource.

Product Version Compatibility

Versions 18, 20.1 and later

Interface Type

RESTful API

Hierarchy

Patron Status

 

Input Parameters

REST Resources IDs:

Patron ID: The Aleph patron system identifier

Input URI

<Base URL>:/patron/<patron ID>/patronStatus

For example: To retrieve the Patron Status resource for the patron ID 00000036, use:

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

Output XML Format

The returned XML includes links to the Patron Status sub-resources.

For example:

<?xml version="1.0" encoding="UTF-8"?>
<pat-status>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <patron-status>
    <info type="Blocks" href="http://server.name:1892/rest-dlf/patron/00000036/patronStatus/blocks"/>
    <info type="Registration" href="http://server.name:1892/rest-dlf/patron/00000036/patronStatus/registration"/>
  </patron-status>
</pat-status>

In Aleph 22.1 and later the returned XML can include also the following patron notices: overdue loans, cash balance, account expiry and delinquencies.

The display of patron notices is configured in the same way of displaying patron notices in the Web OPAC. (please refer to the “Aleph System Librarians Guide – Web OPAC”).

Example with patron notices (under <alerts> – Aleph 22.1 and later):

<?xml version = "1.0" encoding = "UTF-8"?>
<pat-status>
    <reply-text>ok</reply-text>
    <reply-code>0000</reply-code>
    <patron-status>
        <info type="Blocks" href="http://server.name:1892/rest-dlf/patron/00000036/patronStatus/blocks"/>
        <info type="Registration" href="http://server.name:1892/rest-dlf/patron/00000036/patronStatus/registration"/>
        <alerts>
            <overdue-alerts>You have overdue items currently on loan in library Exlibris Demo Libraries (USM50), USM51 Demo Libraries (USM51)</overdue-alerts>
            <fines-alert>You have pending cash transactions in library Exlibris Demo Libraries (USM50)</fines-alert>
            <blocks-alerts>You have delinquencies in library Exlibris Demo Libraries (USM50)</blocks-alerts>
        </alerts>
    </patron-status>
</pat-status>

Possible Error Codes

02 : The patron ID is invalid