hold_req

General Purpose

The service creates a hold-request record (Z37) for a given item after performing initial checks.

Interface Type

X-Service

Product Version Compatibility

Version 18 and later

Input Parameters

1. LIBRARY – X (5).
2. REC_KEY.
2.1 DOC_NUMBER – 9 (9).
2.2 ITEM_SEQUENCE – 9 (6).
3. ITEM_BARCODE – X (20).
4. BOR_ID – X (12).

  • Library: The library of the loaned Item for which the user would like to create a hold request.

Only one of the following two parameters are necessary:

  • Rec_Key: Doc Number + Item Sequence (Key of Z30).
  • Item_Barcode: ID of the item (Z30).
  • Bor_Id/Identification/Id: Borrower_Id (Patron) for Hold-Request.

Output XML Format

The output XML includes an OK response if the hold request record was successfully created.

Example:

The user would like to create a hold-request for:

  • Patron: 1930
  • Doc_Number: 50646
  • Item_Sequence: 20
  • Item_Barcode: 32044024520026
http://ram19:8995/X?op=hold-req&doc_number=000050646&item_sequence=000200&bor_id=1930&library=usm50

The next URL is the same because the barcode is a unique identifier:

http://ram19:8995/X?op=hold-req&item_barcode=32044024520026&bor_id=1930&library=usm50

The following is the XML output:

<?xml version = "1.0" encoding = "UTF-8"?>
<hold-req>
  <reply>ok</reply>
  <z37>
    <z37-doc-number>000050646</z37-doc-number>
    <z37-item-sequence>000200</z37-item-sequence>
    <z37-sequence>0001</z37-sequence>
    <z37-id>1930</z37-id>
    <z37-status>In process</z37-status>
    <z37-expand>Y</z37-expand>
    <z37-priority>05</z37-priority>
    <z37-open-date>20/11/2018</z37-open-date>
    <z37-open-hour>09:28</z37-open-hour>
    <z37-request-date>20/11/2018</z37-request-date>
    <z37-end-request-date>20/11/2019</z37-end-request-date>
    <z37-hold-date></z37-hold-date>
    <z37-letter-status></z37-letter-status>
    <z37-letter-date></z37-letter-date>
    <z37-alpha>L</z37-alpha>
    <z37-author></z37-author>
    <z37-title></z37-title>
    <z37-pages></z37-pages>
    <z37-note-1></z37-note-1>
    <z37-note-2></z37-note-2>
    <z37-print-status></z37-print-status>
    <z37-requester-id></z37-requester-id>
    <z37-cataloger-name>WWW-X</z37-cataloger-name>
    <z37-cataloger-ip>10.1.116.222</z37-cataloger-ip>
    <z37-hold-sequence>000</z37-hold-sequence>
    <z37-pickup-location>Main Library</z37-pickup-location>
    <z37-send-action>01</z37-send-action>
    <z37-end-hold-date></z37-end-hold-date>
    <z37-recall-type>01</z37-recall-type>
    <z37-rush-request>No</z37-rush-request>
    <z37-filter-sub-library>WID</z37-filter-sub-library>
    <z37-filter-item-status>01</z37-filter-item-status>
    <z37-filter-process-status></z37-filter-process-status>
    <z37-filter-collection></z37-filter-collection>
    <z37-filter-copy>00000</z37-filter-copy>
    <z37-enumeration-a></z37-enumeration-a>
    <z37-enumeration-b></z37-enumeration-b>
    <z37-enumeration-c></z37-enumeration-c>
    <z37-chronological-i></z37-chronological-i>
    <z37-chronological-j></z37-chronological-j>
    <z37-chronological-k></z37-chronological-k>
    <z37-request-type>H</z37-request-type>
    <z37-booking-start-date>00000000</z37-booking-start-date>
    <z37-booking-start-hour>0000</z37-booking-start-hour>
    <z37-booking-end-date>00000000</z37-booking-end-date>
    <z37-booking-end-hour>0000</z37-booking-end-hour>
    <z37-booking-orig-start-time></z37-booking-orig-start-time>
    <z37-booking-orig-end-time></z37-booking-orig-end-time>
    <z37-release-time></z37-release-time>
    <z37-delivery-time></z37-delivery-time>
    <z37-head-time></z37-head-time>
    <z37-tail-time></z37-tail-time>
    <z37-delivery-sub-location></z37-delivery-sub-location>
    <z37-return-location></z37-return-location>
    <z37-return-sub-location></z37-return-sub-location>
    <z37-delivery-method></z37-delivery-method>
    <z37-effective-start-time></z37-effective-start-time>
    <z37-effective-end-time></z37-effective-end-time>
    <z37-request-number>000001010</z37-request-number>
    <z37-group-id>000000000</z37-group-id>
    <z37-group-sequence>000000</z37-group-sequence>
    <z37-balancer-status></z37-balancer-status>
    <z37-balancer-date>00000000</z37-balancer-date>
    <z37-request-identifier></z37-request-identifier>
    <z37-requester-name></z37-requester-name>
    <z37-upd-time-stamp>201811200928405</z37-upd-time-stamp>
    <z37-cataloger-ip-v6></z37-cataloger-ip-v6>
  </z37>
  <session-id>I7L4LGJ777V2IBJ28HYFCKL7Q2E6S2IEL97CSR1SHEFAJT7D6F</session-id>
</hold-req>

Possible Error Codes

1. If the user tried to activate the X-Service without entering the doc number and item sequence, or item barcode:

< error>Both Doc number and item sequence should be filled OR item barcode only.</error>

2. If borrower given by the user could not be found in Z303:

< error>Error retrieving patron record</error>

3. If the item could not be found:

< error>Error retrieving item record</error>

4.If Local information record (Z305) of the Patron could not be found:

< error>Error retrieving local patron record</error>