Bookings

General Purpose

The resource may be accessed with a GET method to retrieve a specific patron’s bookings information. The bookings information may be retrieved as a patron’s booking list, or as a specific booking’s information. The bookings list information is exported per institution (ADM library).

Note that booking requests include both short loan requests and rolling booking requests.

The resource may be accessed with a DELETE method to cancel a booking or short loan request.

Product Version Compatibility

Versions 18, 20.1 and later

Interface Type

RESTful API

Hierarchy

Bookings

 

 

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

Booking ID: The ID of the specific booking that is requested. May be used to fetch a specific booking’s information.

URL Parameters

institution: The ID of an institution (ADM library) for which the information is requested. Optional.

view: The format in which the bookings list will be displayed. Possible values are brief and full. Optional.

Input URI

Bookings List:

<Base URL>:/patron/<patron ID>/circulationActions/requests/bookings?institution=<Institution ID>

For example:

To retrieve the bookings list for the patron ID 00000036, use:
http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings

To retrieve the bookings list for the patron ID 00000036 for a specific institution, use:
http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings?institution=USM50

To retrieve the bookings list for the patron ID 00000036 in brief format, use:
http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings?view=brief

To retrieve the bookings list for the patron ID 00000036 in full format, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings?view=full

Specific Booking:

<Base URL>:/patron/<patron ID>/circulationActions/requests/bookings/<booking id>

For example:

To retrieve a specific booking’s information for the patron ID 00000036, use:
http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings/USM500000000170000200001

Use the same URL with a DELETE method to cancel a booking or short loan request.

Output XML Format

The returned XML includes the patron’s bookings lists per institution, or a specific booking’s information.

The information is exported as Z37,Z30 and Z13 tags. When setting the view parameter to full, the records are fully extracted. When setting the view parameter to brief, only some of the elements are extracted.

Note the delete attribute, which indicates whether or not the request may be cancelled in a DELETE action.

The list of institutes can be limited to those in which the patron is active, depending on the institute’s setup of the FILTER-LIBRARY-CARD tab100 variable.

Bookings list example:

<?xml version="1.0" encoding="UTF-8"?>
<pat-books-list>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <booking-requests>
    <translate-change-active-library>USM50</translate-change-active-library>
    <institution code="USM50">
      <inst-name>Exlibris Demo Libraries</inst-name>
      <booking-request delete="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings/USM500000000170000200001"/>
      <booking-request delete="N" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings/USM500000000210000200001"/>
    </institution>
    <translate-change-active-library>USM51</translate-change-active-library>
    <institution code="USM51">
      <inst-name>USM51 Demo Libraries</inst-name>
    </institution>
    <translate-change-active-library>MAB50</translate-change-active-library>
    <institution code="MAB50">
      <inst-name>MAB Demo Library</inst-name>
    </institution>
  </booking-requests>
</pat-books-list>

Specific booking example:

<?xml version="1.0" encoding="UTF-8"?>
<get-pat-book>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <booking-request delete="N">
    <status>In process: Start Date 01/03/06, End date 07/03/06.</status>
    <z37>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z37-doc-number>000000017</z37-doc-number>
      <z37-item-sequence>000020</z37-item-sequence>
      <z37-sequence>0001</z37-sequence>
      <z37-id>00000036</z37-id>
      <z37-status>In process</z37-status>
      <z37-expand>Y</z37-expand>
      <z37-priority>00</z37-priority>
      <z37-open-date>20060228</z37-open-date>
      <z37-open-hour>1131</z37-open-hour>
      <z37-request-date>00000000</z37-request-date>
      <z37-end-request-date>00000000</z37-end-request-date>
      <z37-hold-date>00000000</z37-hold-date>
      <z37-letter-status/>
      <z37-letter-date>00000000</z37-letter-date>
      <z37-alpha>L</z37-alpha>
      <z37-author/>
      <z37-title/>
      <z37-pages/>
      <z37-note-1/>
      <z37-note-2/>
      <z37-print-status/>
      <z37-requester-id/>
      <z37-cataloger-name>MASTER</z37-cataloger-name>
      <z37-cataloger-ip>010.001.235.173</z37-cataloger-ip>
      <z37-hold-sequence>000</z37-hold-sequence>
      <z37-pickup-location>Law Library</z37-pickup-location>
      <z37-send-action>06</z37-send-action>
      <z37-end-hold-date>00000000</z37-end-hold-date>
      <z37-recall-type>03</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-collection>GEN</z37-filter-collection>
      <z37-filter-copy>00000</z37-filter-copy>
      <z37-enumeration-a/>
      <z37-enumeration-b/>
      <z37-enumeration-c/>
      <z37-chronological-i/>
      <z37-chronological-j/>
      <z37-chronological-k/>
      <z37-request-type>Booking Request</z37-request-type>
      <z37-booking-start-date>20060301</z37-booking-start-date>
      <z37-booking-start-hour>0900</z37-booking-start-hour>
      <z37-booking-end-date>20060307</z37-booking-end-date>
      <z37-booking-end-hour>1200</z37-booking-end-hour>
      <z37-booking-orig-start-time>200603010900</z37-booking-orig-start-time>
      <z37-booking-orig-end-time>200603071200</z37-booking-orig-end-time>
      <z37-release-time>M040</z37-release-time>
      <z37-delivery-time>M015</z37-delivery-time>
      <z37-head-time>M035</z37-head-time>
      <z37-tail-time>M025</z37-tail-time>
      <z37-delivery-sub-location/>
      <z37-return-location/>
      <z37-return-sub-location/>
      <z37-delivery-method/>
      <z37-effective-start-time>200603010810</z37-effective-start-time>
      <z37-effective-end-time>200603071240</z37-effective-end-time>
      <z37-request-number>000000848</z37-request-number>
      <z37-group-id>000000000</z37-group-id>
      <z37-group-sequence>000000</z37-group-sequence>
      <z37-balancer-status/>
      <z37-balancer-date>00000000</z37-balancer-date>
      <z37-request-identifier/>
      <z37-requester-name/>
      <z37-upd-time-stamp>200001011200000</z37-upd-time-stamp>
      <z37-cataloger-ip-v6/>
    </z37>
    <z30-sub-library-code>WID</z30-sub-library-code>
    <z30-item-status-code>01</z30-item-status-code>
    <z30-item-process-status-code/>
    <z30-collection-code>GEN</z30-collection-code>
    <z30>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z30-doc-number>000000017</z30-doc-number>
      <z30-item-sequence>    2.0</z30-item-sequence>
      <z30-barcode>32044012580759</z30-barcode>
      <z30-sub-library>Main Library</z30-sub-library>
      <z30-material>Book</z30-material>
      <z30-item-status>Regular loan</z30-item-status>
      <z30-open-date>19900529</z30-open-date>
      <z30-update-date>19950322</z30-update-date>
      <z30-cataloger>CONV</z30-cataloger>
      <z30-date-last-return>19950322</z30-date-last-return>
      <z30-hour-last-return>1643</z30-hour-last-return>
      <z30-ip-last-return>CONV</z30-ip-last-return>
      <z30-no-loans>005</z30-no-loans>
      <z30-alpha>L</z30-alpha>
      <z30-collection>General</z30-collection>
      <z30-call-no-type>7</z30-call-no-type>
      <z30-call-no>Heb 6699.100.5F</z30-call-no>
      <z30-call-no-key>heb       06699 00100 0005 0000 0000 f</z30-call-no-key>
      <z30-call-no-2-type/>
      <z30-call-no-2/>
      <z30-call-no-2-key/>
      <z30-description>v.3-4</z30-description>
      <z30-note-opac/>
      <z30-note-circulation/>
      <z30-note-internal/>
      <z30-order-number/>
      <z30-inventory-number/>
      <z30-inventory-number-date>00000000</z30-inventory-number-date>
      <z30-last-shelf-report-date>00000000</z30-last-shelf-report-date>
      <z30-price/>
      <z30-shelf-report-number/>
      <z30-on-shelf-date>00000000</z30-on-shelf-date>
      <z30-on-shelf-seq>000000</z30-on-shelf-seq>
      <z30-doc-number-2>000000017</z30-doc-number-2>
      <z30-schedule-sequence-2>00000</z30-schedule-sequence-2>
      <z30-copy-sequence-2>00000</z30-copy-sequence-2>
      <z30-vendor-code/>
      <z30-invoice-number/>
      <z30-line-number>00000</z30-line-number>
      <z30-pages/>
      <z30-issue-date>00000000</z30-issue-date>
      <z30-expected-arrival-date>0</z30-expected-arrival-date>
      <z30-arrival-date>0</z30-arrival-date>
      <z30-item-statistic/>
      <z30-item-process-status>Not in Process</z30-item-process-status>
      <z30-copy-id/>
      <z30-hol-doc-number>000000052</z30-hol-doc-number>
      <z30-temp-location>No</z30-temp-location>
      <z30-enumeration-a/>
      <z30-enumeration-b/>
      <z30-enumeration-c/>
      <z30-enumeration-d/>
      <z30-enumeration-e/>
      <z30-enumeration-f/>
      <z30-enumeration-g/>
      <z30-enumeration-h/>
      <z30-chronological-i/>
      <z30-chronological-j/>
      <z30-chronological-k/>
      <z30-chronological-l/>
      <z30-chronological-m/>
      <z30-supp-index-o/>
      <z30-85x-type/>
      <z30-depository-id/>
      <z30-linking-number>000000000</z30-linking-number>
      <z30-gap-indicator/>
      <z30-maintenance-count>000</z30-maintenance-count>
      <z30-process-status-date>00000000</z30-process-status-date>
      <z30-upd-time-stamp>200001011200000</z30-upd-time-stamp>
      <z30-ip-last-return-v6/>
    </z30>
    <z13>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z13-doc-number>000000017</z13-doc-number>
      <z13-year>1963</z13-year>
      <z13-open-date>20040307</z13-open-date>
      <z13-update-date>20040307</z13-update-date>
      <z13-call-no-key/>
      <z13-call-no-code/>
      <z13-call-no/>
      <z13-author-code>1001</z13-author-code>
      <z13-author>Duran, Simeon ben ?ema?, 1361-1444.</z13-author>
      <z13-title-code>24513</z13-title-code>
      <z13-title>ha-Tashbets :</z13-title>
      <z13-imprint-code>2600</z13-imprint-code>
      <z13-imprint>Tel Aviv : ha-Hafatsah ha-bil?adit bi-yede ?. Gi?ler, [1963 or 1964]</z13-imprint>
      <z13-isbn-issn-code/>
      <z13-isbn-issn/>
      <z13-upd-time-stamp>200001011200000</z13-upd-time-stamp>
    </z13>
  </booking-request>
</get-pat-book>

Cancel booking example:

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

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid

05 : Request does not belong to the requested patron

08 : Request does not exist

13 : Request cancellation failed