Ready to Learn?Ex Libris products all provide open APIs

bor_auth

General Purpose


This service retrieves the Global record (Z303), Local record (Z305) and the Data record (Z304) for a given Patron if the given ID and verification code match.

Otherwise, an error message is returned.


 

Interface Type

X-Service

 

Product Version Compatibility

Version 18 and later


 

Input Parameters

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

NOTE: The online check calls the check_bor_id parameter, meaning that Verification is a mandatory field.
 

  • Library: The user inserts the library to be used as part of the key to the local record (Z305) in the event that the sub-library has not been given as an input. This is the library in which the local record (Z305) exists. It also defines the context for which the global records (Z303 and Z304) are retrieved.
  • Sub_Library: This is the sub-library for receiving the local record (Z305).
  • Bor_Id / Identification/ ID: Borrower's ID (Patron) for which the user wants full information.
  • Verification: Password of the borrower's ID (Verification in Z308).


 

Output XML Format

The output XML includes the Global record (Z303), Local record (Z305) and the Data record (Z304) for the borrower ID given by the user.

Example:

To retrieve data on borrower ID 00000012 with verification 00000012, for sub-library HIL, local record is under USM50, enter the following URL:


 

http://ram19:8995/X?op=bor-auth&library=usm50&bor_id=00000012&verification=00000012&sub_library=HIL


If all goes well, the output XML will contain Z303, Z304 and Z305:

<?xml version="1.0" encoding="UTF-8"
   ?>
       - <bor-auth>
       - <z303>
        <z303-id>00000012</z303-id>
        <z303-proxy-for-id />
        <z303-primary-id />
        <z303-name-key>de lossa robert 00000012</z303-name-key>
        <z303-user-library />
        <z303-open-date>June/23/1989</z303-open-date>
        <z303-update-date>March/30/2004</z303-update-date>
        <z303-con-lng>ENG</z303-con-lng>
        <z303-alpha>L</z303-alpha>
        <z303-name>De Lossa, Robert</z303-name>
        <z303-title />
        <z303-delinq-1>03</z303-delinq-1>
        <z303-delinq-n-1>Personal item left in library - contact
  Circ  desk</z303-delinq-n-1>
        <z303-delinq-1-update-date>20040330</z303-delinq-1-update-date>
        <z303-delinq-1-cat-name>MASTER</z303-delinq-1-cat-name>
        <z303-delinq-2>00</z303-delinq-2>
        <z303-delinq-n-2 />
        <z303-delinq-2-update-date>00000000</z303-delinq-2-update-date>
        <z303-delinq-2-cat-name>CONVERSION</z303-delinq-2-cat-name>
        <z303-delinq-3>00</z303-delinq-3>
        <z303-delinq-n-3 />
        <z303-delinq-3-update-date>00000000</z303-delinq-3-update-date>
        <z303-delinq-3-cat-name>CONVERSION</z303-delinq-3-cat-name>
        <z303-budget />
        <z303-profile-id />
        <z303-ill-library />
        <z303-home-library>Humanities Library</z303-home-library>
        <z303-field-1 />
        <z303-field-2 />
        <z303-field-3 />
        <z303-ill-total-limit>0000</z303-ill-total-limit>
        <z303-ill-active-limit>0000</z303-ill-active-limit>
        <z303-dispatch-library />
        <z303-birth-date />
        <z303-export-consent>Y</z303-export-consent>
        <z303-proxy-id-type>00</z303-proxy-id-type>
        <z303-send-all-letters>Y</z303-send-all-letters>
        <z303-plif-modification />
        </z303>
       - <z304>
        <z304-id>00000012</z304-id>

        <z304-sequence>01</z304-sequence>
        <z304-address-0>Robert Hatoum</z304-address-0>
        <z304-address-1>Ukrainian Research Institute</z304-address-1>
        <z304-address-2>1583 Massachusetts Avenue</z304-address-2>
        <z304-address-3>Oxford St Mail Area H0163</z304-address-3>
        <z304-zip>H0163</z304-zip>
        <z304-email-address>ilana.goldshmidt@exlibris.co.il</z304-email-address>
        <z304-telephone />
        <z304-date-from>20020814</z304-date-from>
        <z304-date-to>20060830</z304-date-to>
        <z304-address-type>02</z304-address-type>
        <z304-telephone-2 />
        <z304-telephone-3 />
        <z304-telephone-4 />
        <z304-update-date>20040504</z304-update-date>
        <z304-cat-name>MASTER</z304-cat-name>
        </z304>
       - <z305>
        <z305-id>00000012</z305-id>
        <z305-sub-library>HIL</z305-sub-library>
        <z305-open-date>May/04/2004</z305-open-date>
        <z305-update-date>May/04/2004</z305-update-date>
        <z305-bor-type />
        <z305-bor-status>Staff</z305-bor-status>
        <z305-expiry-date>January/01/2007</z305-expiry-date>
        <z305-note />
        <z305-loan-permission>Y</z305-loan-permission>
        <z305-photo-permission>Y</z305-photo-permission>
        <z305-over-permission>N</z305-over-permission>
        <z305-multi-hold>Y</z305-multi-hold>
        <z305-loan-check>N</z305-loan-check>
        <z305-delivery-type />
        <z305-hold-permission>Y</z305-hold-permission>
        <z305-renew-permission>Y</z305-renew-permission>
        <z305-rr-permission>N</z305-rr-permission>
        <z305-ignore-late-return>N</z305-ignore-late-return>
        <z305-last-activity-date />
        <z305-photo-charge>C</z305-photo-charge>
        <z305-no-loan>0000</z305-no-loan>
        <z305-no-hold>0000</z305-no-hold>
        <z305-no-photo>0000</z305-no-photo>
        <z305-no-cash>0000</z305-no-cash>
        <z305-cash-limit>0.00</z305-cash-limit>
        <z305-credit-debit />
        <z305-sum>0.00</z305-sum>
        <z305-delinq-1>00</z305-delinq-1>
        <z305-delinq-n-1 />
        <z305-delinq-1-update-date>20040504</z305-delinq-1-update-date>
        <z305-delinq-1-cat-name>MASTER</z305-delinq-1-cat-name>
        <z305-delinq-2>00</z305-delinq-2>
        <z305-delinq-n-2 />
        <z305-delinq-2-update-date>20040504</z305-delinq-2-update-date>
        <z305-delinq-2-cat-name>MASTER</z305-delinq-2-cat-name>
        <z305-delinq-3>00</z305-delinq-3>
        <z305-delinq-n-3 />
        <z305-delinq-3-update-date>20040504</z305-delinq-3-update-date>
        <z305-delinq-3-cat-name>MASTER</z305-delinq-3-cat-name>
        <z305-field-1 />
        <z305-field-2 />
        <z305-field-3 />
        <z305-hold-on-shelf>N</z305-hold-on-shelf>
        <z305-end-block-date />
        <z305-booking-permission />
        <z305-booking-ignore-hours />
        </z305>
        <session-id>B98R9EB8RH3IUSFDNEKNSQPRBJ51R3KC2FEJVGDC7SF5JL1XES</session-id>
        </bor-auth>


 

Possible Error Codes

1. When the Bor Auth X-Service is run without giving the Borrower ID and Verification as input, the following error message appears in the XML output:

<error>Both Bor_Id and Verification must be filled</error>

2. If, for some reason, an error occurs during the verification check:

<error>Error in Verification</error>

3. If a global record (Z303) is not found for a given patron:

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

4. If a local record (Z305) is not found for a given patron:

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