Skip to main content
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Item Display Limit for OvP from Aleph RESTful API?

    • Article Type: General
    • Product: Aleph
    • Product Version: 20

    Rep_change 3467 (below) leads me to believe that paging is possible beyond 990. Is that true?

    The Get Items List DLF service returns the requested number of items starting from the first item. It is impossible to fetch the desired number of items from a specific starting position in the items list.
    This has been corrected. A new parameter, startPos, has been added to the Get Items List DLF service. This parameter indicates the starting position of the returned items list. It is optional. Its values can range from 1 to 990. The default value is 1.

    No more than 990 items can be returned in one call from the Aleph RESTful API (DLF).
    The following mechanisms CAN be used to display all items in a user-friendly item display (since it would be cumbersome for patrons to browse through such long lists of items).
    Using these tools, it is possible to display all items as long as the filters return sets less than or equal to 990 items.

    Filtering & Paging Examples

    Aleph provides other retrieval options in order to provide a user-friendly method of accessing item lists for records which have large numbers of items.

    [1] paging – this only works to a maximum of 990 records; use filters to reduce the item result set
    * noItems: May be used to indicate the number of items returned by the service (maximum 990). Optional.
    * startPos: May be used to indicate the starting position of the returned items list. Possible values: number between 0 and 990. Optional.

    [2] filtering
    * institution: The ID of an institution (ADM library) for which the information is requested. 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.
    * 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.
    * 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.

    For example, this URL returns only 990 items although there are over 1000 items for the bibliographic record:

    If we want to see all the items, we can use filtering to display the items by year. The following URLs will return all the items, grouped by year (approximately 200, 365, 365, and 70).

    This set of 365 items from 2011 can be made easier for the patron to browse via the paging mechanism:

    Example of 990 Limit – Record more than 1000 items
    Returns 990 items.
    These are the last 3:
    <item href="http://il-aleph07:1893/rest-dlf/record/USM01000050630/items/USM50000050630009880" />
    <item href="http://il-aleph07:1893/rest-dlf/record/USM01000050630/items/USM50000050630009890" />
    <item href="http://il-aleph07:1893/rest-dlf/record/USM01000050630/items/USM50000050630009900" />

    Returns only 3 items, the same as those shown in the list above.

    Since “noItems=988&startPos=988” would ask the system to retrieve at least 1980 items in order to find items 991 to 1980, this query cannot work.

    Note: There is a known issue of filters not working beyond 1000 filter elements (for example, more than 1000 volumes). The issue is currently in Development (KB # 34159)

    • Article last edited: 10/8/2013