Ready to Learn?Ex Libris products all provide open APIs

bor_by_key

General Purpose

The service retrieves the internal ID (From Z308) for a given Borrower_id if the provided ID and verification code match.

If they do not an error message is returned.

 

Interface Type

X-Service

 

Product Version Compatibility

Version 18 and later


 

Input Parameters

1. LIBRARY - X (5).
2. BOR_ID - X (20).
3. VERIFICATION - X (20).

NOTE: The X-Service calls "check_bor_id" with type of check: GUI. That means the verification is NOT a mandatory field, and the user does not have to fill it in.
 

  • Library: The user does not have to fill in this parameter.
  • Bor_Id/Identification/Id: Borrower_Id (Patron) on which the user would like to get Internal_Id.
  • Verification: Password of the Borrower_id (Verification in Z308). The user does not have to fill in this parameter.


 

Output XML Format

The output XML will include the Internal_Id for the Borrower_id given by the user (From Z308).

If the user would like to get data on borrower_id: 12, with verification=12:

* [http://ram19:8995/X?op=bor-by-key&bor_id=00000012&verification=00000012]
* [http://ram19:8995]/X?op=bor-by-key&bor_id=00000012


If this is successful, the output XML contains the Internal_Id in the two examples above:

Example:

<?xml version="1.0" encoding="UTF-8" ?>
         - <bor-by-key>
      <internal-id>00000012</internal-id>
       <session-  id>MQCE3DG3SECET7SGSG1HYJJUFHL6M6H3MQJ1CUP2P75F6 N6FQ1</session-id>
        </bor-by-key>


 

Possible Error Codes

1. If the user tried to activate Sort Set X-Service without giving Borrower_id as an input:

< error>Bor_Id must be filled</error>

2. If an error occurred while trying to check verification:

< error>Error in Verification</error>

3. If the global record (Z303) could not be found for a patron:

< error>Error retrieving Global Patron Record</error>