Items per Patron

General Purpose

The resource may be accessed with a GET method to retrieve a specific item’s information, including the patron’s allowed actions on the given item.

Product Version Compatibility

Versions 18, 20.1 and later

Interface Type

RESTful API

Hierarchy

Items per Patron

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

Record ID: The Aleph BIB record identifier. The identifier is composed of the BIB library code + the system number. For example, USM01000050362

Item ID: The Aleph item record identifier. The item ID may be used to fetch a specific item’s information. The identifier is composed of the ADM library code + the item record key. For example, USM50000030437000010.

Input URI

<Base URL>:/patron/<patron ID>/record/<record ID>/items/<item ID>

For example:

To retrieve a specific item’s information for BIB record 000030437, use:

http://server.name:1892/rest-dlf/patron/00000036/record/USM01000030437/items/USM50000030437000010

Output XML Format

The returned XML includes a specific item’s information, including the patron’s allowed actions on the given item.

The information is exported as Z30, Z36 and Z13 tags, in addition to the following special tags:

  • status – a textual description of the item’s circulation status.
  • queue – information on the item’s requests queue.
  • hol-library – the HOL library to which the item is linked (in Aleph 22.1.5, 23.0.2 and later).

The first request type which is allowed is expanded to include additional requesting information.

For example:

<?xml version="1.0" encoding="UTF-8"?>
<item-serv>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <item>
    <z30-sub-library-code>WID</z30-sub-library-code>
    <z30-item-process-status-code/>
    <z30-item-status-code>01</z30-item-status-code>
    <z30-collection-code>WIDLC</z30-collection-code>
    <queue/>
    <z30>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z30-doc-number>000030437</z30-doc-number>
      <z30-item-sequence>    1.0</z30-item-sequence>
      <z30-barcode>32044022521538</z30-barcode>
      <z30-sub-library>Main Library</z30-sub-library>
      <z30-material>Book</z30-material>
      <z30-item-status>Regular loan</z30-item-status>
      <z30-pen-date>19931208</z30-open-date>
      <z30-update-date>20011009</z30-update-date>
      <z30-cataloger>CONV</z30-cataloger>
      <z30-date-last-return>20140101</z30-date-last-return>
      <z30-hour-last-return>1156</z30-hour-last-return>
      <z30-ip-last-return>10.1.117.65</z30-ip-last-return>
      <z30-no-loans>005</z30-no-loans>
      <z30-alpha>L</z30-alpha>
      <z30-collection>WID-LC</z30-collection>
      <z30-call-no-type>0</z30-call-no-type>
      <z30-call-no>PQ2631.R63 A72 1992x</z30-call-no>
      <z30-call-no-key>0 pq#2631 r63 a72 1992x 0</z30-call-no-key>
      <z30-call-no-2-type/>
      <z30-call-no-2/>
      <z30-call-no-2-key/>
      <z30-description>vol. 1</z30-description>
      <z30-note-opac/>
      <z30-note-circulation>CIRC REVIEW!</z30-note-circulation>
      <z30-note-internal>Return to Tracing for patron use - 10/12/00</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>000030437</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>000000000</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>001</z30-maintenance-count>
      <z30-process-status-date>20140101</z30-process-status-date>
      <z30-upd-time-stamp>201401011156123</z30-upd-time-stamp>
      <z30-ip-last-return-v6/>
    </z30>
    <z13>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z13-doc-number>000030437</z13-doc-number>
      <z13-year>1992</z13-year>
      <z13-open-date>20040307</z13-open-date>
      <z13-update-date>20140101</z13-update-date>
      <z13-call-no-key/>
      <z13-call-no-code>LOC0</z13-call-no-code>
      <z13-call-no>PQ2631.R63</z13-call-no>
      <z13-author-code>1001</z13-author-code>
      <z13-author>Proust, Marcel, 1871-1922.</z13-author>
      <z13-title-code>24510</z13-title-code>
      <z13-title>In search of lost time /</z13-title>
      <z13-imprint-code>260</z13-imprint-code>
      <z13-imprint>London : Chatto & Windus, 1992.</z13-imprint>
      <z13-isbn-issn-code>020</z13-isbn-issn-code>
      <z13-isbn-issn>0701137681 (v. 1)</z13-isbn-issn>
      <z13-upd-time-stamp>201401011156160</z13-upd-time-stamp>
    </z13>
    <status>On Shelf</status>
    <info type="HoldRequest" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000030437/items/USM50000030437000010/hold" allowed="Y">
      <hold allowed="Y">
        <pickup-locations default="Y" usage="Mandatory">
          <pickup-location code="LAW">Law Library</pickup-location>
          <pickup-location code="LIT">Economics Library</pickup-location>
        </pickup-locations>
        <note type="info">Item is on an open shelf.</note>
        <note type="info">Item status: Regular loan (01) Call number: PQ2631.R63 A72 1992x,</note>
        <note type="info">Item Description: vol. 1</note>
        <note type="info">Requested item has a like copy on shelf.</note>
        <last-interest-date usage="Optional">20140307</last-interest-date>
        <start-interest-date usage="Optional"/>
        <sub-author usage="Optional" max_len="50"/>
        <sub-title usage="Optional" max_len="100"/>
        <pages usage="Optional" max_len="30"/>
        <note-1 usage="Optional" max_len="50"/>
        <note-2 usage="Optional" max_len="50"/>
        <rush usage="Optional"/>
      </hold>
    </info>
    <info type="ShortLoan" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000030437/items/USM50000030437000010/shortLoan" allowed="N">
      <note type="error">The item has no short loan schedule</note>
    </info>
    <info type="PhotoRequest" href="http://server.name:1892/rest-dlf/patron/00000036/record/USM01000030437/items/USM50000030437000010/photo" allowed="Y"/>
    <info type="BookingRequest" allowed="Y">
      <adm-library>USM50</adm-library>
      <adm-doc-number>000030437</adm-doc-number>
      <item-sequence>000010</item-sequence>
      <exact-item>N</exact-item>
    </info>
  </item>
</item-serv>

Possible Error Codes

02 : The patron ID is invalid

19 : Record does not exist

27 : Item does not exist