Ready to Learn?Ex Libris products all provide open APIs

Password

Password

 

General Purpose

The resource may be accessed with a GET method to retrieve information regarding the fields that are required for an update action.

The resource may be accessed with a POST method to update the patron's password.


Product Version Compatibility

Versions 22.01 and later.


Interface Type

RESTful API

Hierarchy

 

 

 

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

 

Input URI

<Base URL>:/patron/<patron ID>/patronInformation/password

For example:
http://server.name:1892/rest-dlf/patron/00000036/patronInformation/password

 

 

Input XML Format

To update the password for a patron, use the same URL with a POST method of HTTP.

The request "Body" of the "POST" method must contain input XML with the old and new passwords.

Changing password will be subject to the standard Aleph password validation procedures, that is:

  • A password is updateable if it has been defined in the tab_bor_id table as such (col.8 is set to Y).
  • When a password update is done , all of the patron’s passwords (that are updateable) will be changed in that single action.

The POST XML must have the same structure as returned in the GET method.

For example:
To update the password for the patron ID 00000036, use the URL:
http://server.name:1892/rest-dlf/patron/00000036/patronInformation/password   with the POST method and XML input:

post_xml=<?xml version = "1.0" encoding = "UTF-8"?>
<get-pat-pswd>
    <password_parameters>
        <old-password>00000036</old-password>
        <new-password>new_pass</new-password>
    </password_parameters>
</get-pat-pswd>

Output XML Format

The returned XML includes indication whether the password has updated successfully. for example:

<?xml version="1.0" encoding="UTF-8"?>
<get-pat-pswd>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <password_parameters updateable="Y">
    <old-password usage="Mandatory" max_len="20"/>
    <new-password usage="Mandatory" max_len="20"/>
  </password_parameters>
</get-pat-pswd>

If the password was successfully created using the POST method, a reply such as the following will be reported:

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

 

Possible Error Codes

02 : The patron ID is invalid

10: Wrong old password. Enter password again 

11: Not permitted to update password