Patron Registration
General Purpose
Retrieves a patron’s registration information. The information is retrieved per institution (ADM library).
Product Version Compatibility
Versions 18, 20.1 and later
Interface Type
RESTful API
Hierarchy
Input Parameters
REST Resources IDs:
Patron ID: The Aleph patron system identifier
URL Parameters:
Institution ID: The ID of an institution (ADM library) for which the information is requested. Optional.
Input URI
<Base URL>:/patron/<patron ID>/patronStatus/registration?institution=<Institution ID>
For example: To retrieve the registration information for the patron ID 00000036, use:
http://server.name:1892/rest-dlf/patron/00000036/patronStatus/registration
To retrieve the registration information for the patron ID 00000036 for a specific institution, use:
http://server.name:1892/rest-dlf/patron/00000036/patronStatus/registration?institution=USM50
Output XML Format
The returned XML reports the patron registration information. The information is exported as Z305 tags.
Example:
<?xml version="1.0" encoding="UTF-8"?> <pat-register> <reply-text>ok</reply-text> <reply-code>0000</reply-code> <registration> <translate-change-active-library>USM50</translate-change-active-library> <institution code="USM50"> <inst-name>Exlibris Demo Libraries</inst-name> <z305-bor-status-code>01</z305-bor-status-code> <z305-bor-status>Faculty</z305-bor-status> <z305-bor-type/> <z305-expiry-date>20501230</z305-expiry-date> </institution> <translate-change-active-library>USM51</translate-change-active-library> <institution code="USM51"> <inst-name>USM51 Demo Libraries</inst-name> <z305-bor-status-code>08</z305-bor-status-code> <z305-bor-status>Research</z305-bor-status> <z305-bor-type/> <z305-expiry-date>20501230</z305-expiry-date> </institution> <translate-change-active-library>MAB50</translate-change-active-library> <institution code="MAB50"> <inst-name>MAB Demo Library</inst-name> <z305-bor-status-code>08</z305-bor-status-code> <z305-bor-status>08</z305-bor-status> <z305-bor-type/> <z305-expiry-date>20501230</z305-expiry-date> </institution> </registration> </pat-register>
Possible Error Codes
02 : The patron ID is invalid
01 : The supplied institution ID is not valid