Ready to Learn?Ex Libris products all provide open APIs

Circulation Actions

General Purpose

Retrieves sub-resources of the Circulation Actions resource, with each sub-resource being a circulation action type. In addition, a summary of how many of each circulation action 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

 

 

Slide9_patrons-patron_id-circ_actions

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?institution=<Institution ID>

For example: To retrieve the circulation actions for the patron ID 00000036, use:

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

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

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


Output XML Format

The returned XML includes links to the Circulation Actions sub-resources, with summaries of each action. 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-circ-acts>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <circulationActions>
    <translate-change-active-library>USM50</translate-change-active-library>
    <institution code="USM50">
      <inst-name>Exlibris Demo Libraries</inst-name>
      <action type="Loans" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans?institution=USM50">
        <amount>4</amount>
      </action>
      <action type="Cash" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/cash?institution=USM50">
        <sum>-27.62</sum>
      </action>
      <action type="Requests" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/requests?institution=USM50">
        <amount>50</amount>
      </action>
      <note type="cash">Please note that there is an additional accrued overdue items fine of: 112.00.</note>
    </institution>
    <translate-change-active-library>USM51</translate-change-active-library>
    <institution code="USM51">
      <inst-name>USM51 Demo Libraries</inst-name>
      <action type="Loans" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans?institution=USM51">
        <amount>2</amount>
      </action>
      <action type="Cash" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/cash?institution=USM51">
        <sum>-4.00</sum>
      </action>
      <action type="Requests" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/requests?institution=USM51">
        <amount>0</amount>
      </action>
      <note type="cash">Please note that there is an additional accrued overdue items fine of: 0.00.</note>
    </institution>
    <translate-change-active-library>MAB50</translate-change-active-library>
    <institution code="MAB50">
      <inst-name>MAB Demo Library</inst-name>
      <action type="Loans" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/loans?institution=MAB50">
        <amount>0</amount>
      </action>
      <action type="Cash" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/cash?institution=MAB50">
        <sum>0.00</sum>
      </action>
      <action type="Requests" href="http://server.name:1893/rest-dlf/patron/00000036/circulationActions/requests?institution=MAB50">
        <amount>0</amount>
      </action>
      <note type="cash">Please note that there is an additional accrued overdue items fine of: 0.00.</note>
    </institution>
    <total type="Loans">6</total>
    <total type="Cash">-31.62</total>
    <total type="Requests">50</total>
    <total type="ActiveRequests">25</total>
  </circulationActions>
</get-circ-acts>

Note:

In Aleph 22.1 and later, the returned XML includes - for each < action type="Cash"   ...> -     the < sum > and also the < currency > .

 

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid