Items

General Purpose

The Items resource may be accessed with a GET method to retrieve a specific BIB record’s items list, or a specific item’s information.

Product Version Compatibility

Versions 18, 20.1 and later

Interface Type

RESTful API

Hierarchy

Records - Items

 

Input Parameters

REST Resource IDs:

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, USM50000238843000320.

URL Parameters:

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

view: The format in which the item record will be displayed. May be used to expand the item information when an items list is exposed. Possible values are full and brief. Optional.

loaned: May be used with the value “NO” to list only non-loaned items. Optional.

volume: May be used to filter the list to include only items of a specific volume. Optional.

year: May be used to filter the list to include only items of a specific year. Optional.

sublibrary: May be used to filter the list to include only items of a specific sublibrary. Optional.

patron: May be used when exposing the items list to include information on the availability of services, such as hold request or short loan request, for the record’s items. Optional.

noItems: May be used to indicate the number of items returned by the service. Optional.

startPos: May be used to indicate the starting position of the returned items list. Possible values: number between 0 and 990. Optional.

sublibs: May be used to indicate which sub libraries should be included. When this parameter populated, the returned items list is per sublibrary. Possible values: list of sublibraries delimited by comma. Optional.

collection (in Aleph 22.1.1 and later): May be used to filter the list to include only items of a specific collection. Must be used with sublibrary or sublibs filter. When using the collection filter, only one sublibrary value should be used in sublibrary/sublibs filter. Optional

holid: (in Aleph 22.1.2 and later) May be used to filter only the items that are linked to the inserted Holding record ID. Optional.

Input URI

Items List:

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

For example:

To retrieve the items list for the BIB record 00050362, use:

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

To view the items list in full view, use:

http://server.name:1892/rest-dlf/record/USM01000030437/items?view=full

To retrieve the items list for BIB record 00050362 and for a specific institution, use:

http://server.name:1892/rest-dlf/record/USM01000030437/items?institution=USM50

To retrieve the items list for BIB record 00050362, filtering in only items that are not on loan, use:

http://server.name:1892/rest-dlf/record/USM01000030437/items?loaned=NO

To retrieve the items list for BIB record 00050362, viewing only items of a specific volume, year, and sublibrary, use:

http://server.name:1892/rest-dlf/record/USM01000030437/items?volume=2&year=1999&sublibrary=WID

To retrieve the items list for BIB record 00050362 with additional information on the permitted services for a specific patron, use:

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

Specific Item:

<Base URL>:/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/record/USM01000030437/items/USM50000030437000010

Output XML Format

The returned XML includes the item lists, or a specific item’s information.

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

  • status – a textual description of the item circulation status
    (according to the ./alephe/error_LNG/circ_status_holding configuration table).
  • queue – information on the item’s requests queue ,
    (according to ./xxx01/form_LNG/dlf_global configuration table – “0545” Error Code entry).
  • hol-library – the HOL library to which the item is linked (in Aleph 22.1.5, 23.0.2 and later).

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 there is an internal limit to the service. No more than 990 items can be returned.

If not all items connected to the BIB record are returned, a <partial> tag is added to the XML.

When using the “noItems” parameter – the service returns the items according to the smaller value in these parameters.

Items list example:

<?xml version="1.0" encoding="UTF-8"?>
<get-item-list>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <items>
    <item href="http://server.name:1892/rest-dlf/record/USM01000030437/items/USM50000030437000010"/>
    <item href="http://server.name:1892/rest-dlf/record/USM01000030437/items/USM50000030437000020"/>
    <item href="http://server.name:1892/rest-dlf/record/USM01000030437/items/USM50000030437000030"/>
    <item href="http://server.name:1892/rest-dlf/record/USM01000030437/items/USM50000030437000040"/>
    <item href="http://server.name:1892/rest-dlf/record/USM01000030437/items/USM50000030437000050"/>
    <item href="http://server.name:1892/rest-dlf/record/USM01000030437/items/USM50000030437000060"/>
  </items>
</get-item-list>

Specific item example:

<?xml version="1.0" encoding="UTF-8"?>
<get-item>
  <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-open-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>
  </item>
</get-item>

Possible Error Codes

19 : Record does not exist

27 : Item does not exist