Ready to Learn?Ex Libris products all provide open APIs

hold_req_cancel

General Purpose


The service deletes the hold-request record (Z37) for a given hold request key (Doc number + Item sequence + Cancel sequence).

 

Interface Type

X-Service

 

Product Version Compatibility

Version 18 and later

 

Input Parameters

1. LIBRARY - X (5).
2. CANCEL_REC_KEY.
2.1 CANCEL_DOC_NUM - 9 (9).
2.2 CANCEL_ITEM_SEQ - 9 (6).
2.3 REQ_CANCEL_SEQ - 9 (4).

NOTE: All parameters are mandatory.
 

  • Library: The library of the loaned Item for which the user would like to cancel the hold request.
  • Rec_Key/Item_id: Doc Number + Item Sequence + Cancel Sequence (Z37 key).
  • Docno/Doc_no/Doc_number: One of the items is the hold request the user would like to cancel.
  • Item_Seq/Item_Sequence - The item for which to cancel the hold request.
  • Seq/Sequence - The cancellation sequence as it appears in Z37.

NOTE: The user can insert rec_key only and make sure that it contains all three components or the user can insert all three components by individually.

 

Output XML Format

The output XML includes an OK reply if the hold request record was successfully deleted.

Example:

The user would like to cancel the hold-request for Patron: 00000077 for Doc_Number: 444, Item_Sequence: 10, sequence = 1:

http://ram19:8995/X?op=hold-req-cancel&doc_number=000000444&item_sequence=000010&sequence=00001&library=usm50


The next URL the same because rec_key contains the same data as the three components:

http://ram19:8995/X?op=hold-req-cancel&rec_key=0000004440000100001&library=usm50


The following is the XML output:

<?xml version="1.0" encoding="UTF-8" ?>
- <hold-req-cancel>
  <reply>ok</reply>
  <session-id>9GFAHNE72RA8Q3TGCRHXELJ9YYV5LFRA9YXICB3ISSI9A524HR</session-id>
  </hold-req-cancel>

 

Possible Error Codes

1. If the user tried to activate the X-Service and rec_key is empty:

< error>Doc number and Item sequence and Cancel sequence must be provided</error>

2. If the user entered doc number, item sequence, and cancel sequence individually and one of these components is empty or zeroes:

< error>Doc number and Item sequence and Cancel sequence must be provided</error>

3. If the hold request record (Z37) could not be found:

< error>Error retrieving hold request record</error>

4. If the hold request record could not be deleted:

< error>Error deleting hold request record</error>