Requests

General Purpose

Retrieves sub-resources of the Requests resource, with each sub-resource being a request type. In addition, a summary of how many of each request type are registered for the patron is also reported. The information is exported per institution (ADM library).

Product Version Compatibility

Versions 18, 20.1 and later

Interface Type

RESTful API

Hierarchy

Slide16_patrons-patron_id-circ_actions-reqs

Requests

 

Input Parameters

REST Resources IDs:

Patron ID: The Aleph patron system identifier

URL Parameters:

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

Input URI

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

For example:

To retrieve the requests for the patron ID 00000036, use:

http://server.name:1893/rest-dlf/patron/00000036/circulationActions/requests

To retrieve the circulation actions for the patron ID 00000036 for a specific institution, use:

http://server.name:1893/rest-dlf/patron/00000036/circulationActions/requests?institution=USM50

Output XML Format

The returned XML includes links to the Requests sub-resources, with summaries of each request type. The information is reported per institution. 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.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<get-pat-reqs>
    <reply-text>ok</reply-text>
    <reply-code>0000</reply-code>
    <requests>
        <translate-change-active-library>USM50</translate-change-active-library>
        <institution code="USM50">
            <inst-name>Exlibris Demo Libraries</inst-name>
            <request type="HoldRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/holds?institution=USM50">
                <amount>4</amount>
            </request>
            <request type="PhotocopyRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies?institution=USM50">
                <amount>1</amount>
            </request>
            <request type="BookingRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings?institution=USM50">
                <amount>2</amount>
            </request>
            <request type="ILL" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill?institution=USM50">
                <amount>43</amount>
            </request>
            <request type="AcquisitionRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq?institution=USM50">
                <amount>0</amount>
            </request>
        </institution>
        <translate-change-active-library>USM51</translate-change-active-library>
        <institution code="USM51">
            <inst-name>USM51 Demo Libraries</inst-name>
            <request type="HoldRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/holds?institution=USM51">
                <amount>0</amount>
            </request>
            <request type="PhotocopyRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies?institution=USM51">
                <amount>0</amount>
            </request>
            <request type="BookingRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings?institution=USM51">
                <amount>0</amount>
            </request>
            <request type="ILL" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill?institution=USM51">
                <amount>0</amount>
            </request>
            <request type="AcquisitionRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq?institution=USM51">
                <amount>0</amount>
            </request>
        </institution>
        <translate-change-active-library>MAB50</translate-change-active-library>
        <institution code="MAB50">
            <inst-name>MAB Demo Library</inst-name>
            <request type="HoldRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/holds?institution=MAB50">
                <amount>0</amount>
            </request>
            <request type="PhotocopyRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/photocopies?institution=MAB50">
                <amount>0</amount>
            </request>
            <request type="BookingRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/bookings?institution=MAB50">
                <amount>0</amount>
            </request>
            <request type="ILL" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/ill?institution=MAB50">
                <amount>0</amount>
            </request>
            <request type="AcquisitionRequest" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq?institution=MAB50">
                <amount>0</amount>
            </request>
        </institution>
        <total type="HoldRequest">4</total>
        <total type="BookingRequest">2</total>
        <total type="ILL">43</total>
        <total type="PhotocopyRequest">1</total>
        <total type="AcquisitionRequest">0</total>
    </requests>
</get-pat-reqs>

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid