Ready to Learn?Ex Libris products all provide open APIs

Filters

General Purpose

The Items resource may be accessed with a GET method - to retrieve filters of a specific BIB record's items list.
This service provides the year, volume, and sublibrary of an item connected to a specific BIB record.


Product Version Compatibility

Versions 18, 20.1 and later


Interface Type

RESTful API

Hierarchy

Slide5-filters

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

URL Parameters:

filters: May be used to indicate the year, volume, and sublibrary of items connected to a specific BIB record.


Input URI

Filters List:

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

For example:

To retrieve the filters which can be applied on record’s items for the BIB record 00028084, use:

http://server.name:1892/rest-dlf/record/USM01000028084/filters


Output XML Format

The returned XML includes the record filters: Volume, Year and Sublibrary.
Filters example: 

For example:

<?xml version="1.0" encoding="UTF-8"?>
<get-filters>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <record-filters>
    <sub-libraries>
      <sub-library>
        <sublib-name>Main Library</sublib-name>
        <sublib-code>WID</sublib-code>
      </sub-library>
    </sub-libraries>
  </record-filters>
</get-filters>

Possible Error Codes

19 : Record does not exist