Ready to Learn?Ex Libris products all provide open APIs

Acquisition Requests Info

General Purpose

The resource may be accessed with a GET method to retrieve a specific patron's acquisition requests information. The acquisition requests information may be retrieved as a patron's acquisition requests list, or as a specific acquisition request's information. The acquisition requests list information is exported per institution (ADM library).

The resource may be accessed with a DELETE method to cancel an acquisition request.

Product Version Compatibility

Versions 18, 20.1 and later

Interface Type

RESTful API

 

Hierarchy

 

Slide13_patrons-patron_id-circ_actions-reqs-acq_reqs

 

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

Acquisition Request  ID: The ID of the specific acquisition request that is requested. May be used to fetch a specific acquisition request's information.

URL Parameters:

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

view: The format in which the acquisition request list will be displayed. Possible values are brief and full. Optional.

type: May be used to restrict the list to a specific type of acquisitions request. Possible values are active, for viewing only the active requests, and cancelled for viewing only cancelled requests. Optional.

closed: May be used to restrict the list to requests that have been closed within a number of days.

Input URI

Acquisition Requests List:

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

For example:

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

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

To retrieve the acquisition requests list for the patron ID 00000036 for a specific institution, use:

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

To retrieve the acquisition requests list for the patron ID 00000036 in brief format, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq?view=brief

To retrieve the acquisition requests list for the patron ID 00000036 in full format, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq?view=full

To retrieve the active acquisition requests list for the patron ID 00000036 in full format, use: 

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq?view=full&type=active

To retrieve the acquisition requests list for the patron ID 00000036 in full format, viewing only requests that have been closed within 40 days, use:
http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq?view=full&closed=40

Specific Acquisition Request:

<Base URL>/patron/<patron ID>/circulationActions/requests/acq/<acq ID>

For example:

To retrieve a specific acquisition request's information for the patron ID 00000036, use:

http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq/USM5000002386900001

Use the same URL with a DELETE method to cancel an acquisition request.

Output XML Format

The returned XML includes the patron's acquisition requests lists per institution, or a specific acquisition request's information.

The information is exported as Z68 and Z13 tags. 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 the delete attribute, which indicates whether or not the request may be cancelled  in a DELETE action.

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.

Acquisition requests list example:

<?xml version="1.0" encoding="UTF-8"?>
<pat-acq-list>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <acq-requests>
    <translate-change-active-library>USM50</translate-change-active-library>
    <institution code="USM50">
      <inst-name>Exlibris Demo Libraries</inst-name>
      <acq-request cancel="Y" href="http://server.name:1892/rest-dlf/patron/00000036/circulationActions/requests/acq/USM5000002386900001"/>
    </institution>
  </acq-requests>
</pat-acq-list>
Specific acquisition request example:
<?xml version="1.0" encoding="UTF-8"?>
<get-pat-acq>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <acq-request cancel="Y">
    <z68>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z68-doc-number>000023869</z68-doc-number>
      <z68-sequence>00001</z68-sequence>
      <z68-order-type>Monograph</z68-order-type>
      <z68-order-number>51490</z68-order-number>
      <z68-order-number-1/>
      <z68-order-number-2/>
      <z68-order-group/>
      <z68-open-date>20140105</z68-open-date>
      <z68-order-status>New</z68-order-status>
      <z68-order-status-date>20140105</z68-order-status-date>
      <z68-arrival-status>Non Arrived</z68-arrival-status>
      <z68-invoice-status>Non Invoiced</z68-invoice-status>
      <z68-last-touch-date>00000000</z68-last-touch-date>
      <z68-sub-library>Law Library</z68-sub-library>
      <z68-alpha>L</z68-alpha>
      <z68-method-of-aquisition>Purchase</z68-method-of-aquisition>
      <z68-order-date>00000000</z68-order-date>
      <z68-material-type/>
      <z68-letter-type>01</z68-letter-type>
      <z68-order-delivery-type>Single letter</z68-order-delivery-type>
      <z68-send-method>Print</z68-send-method>
      <z68-delivery-type>Surface mail</z68-delivery-type>
      <z68-rush/>
      <z68-eda>00000000</z68-eda>
      <z68-original-eda>00000000</z68-original-eda>
      <z68-library-note/>
      <z68-vendor-code>AAA</z68-vendor-code>
      <z68-vendor-reference-no/>
      <z68-vendor-note/>
      <z68-quantity-text/>
      <z68-unit-type/>
      <z68-no-units>1</z68-no-units>
      <z68-unit-price/>
      <z68-total-price/>
      <z68-e-currency>US Dollar</z68-e-currency>
      <z68-e-listed-price>10.00</z68-e-listed-price>
      <z68-e-term-sign>-</z68-e-term-sign>
      <z68-e-term-percent>0.00</z68-e-term-percent>
      <z68-e-price>10.00</z68-e-price>
      <z68-e-local-price>10.00</z68-e-local-price>
      <z68-e-note/>
      <z68-approver-id/>
      <z68-target-id>00000036</z68-target-id>
      <z68-target-text>Aadland, Dustin</z68-target-text>
      <z68-target-flag>None</z68-target-flag>
      <z68-subscription-date-from>00000000</z68-subscription-date-from>
      <z68-subscription-date-to>00000000</z68-subscription-date-to>
      <z68-subscription-renew-date>00000000</z68-subscription-renew-date>
      <z68-subscription-budget-period>1</z68-subscription-budget-period>
      <z68-max-no-arrival-days>0000</z68-max-no-arrival-days>
      <z68-auto-claim>No</z68-auto-claim>
      <z68-isbn/>
      <z68-vendor-contact/>
      <z68-ordering-unit/>
      <z68-erm-type/>
      <z68-erm-id/>
      <z68-upd-time-stamp>201401051458447</z68-upd-time-stamp>
    </z68>
    <z13>
      <translate-change-active-library>USM50</translate-change-active-library>
      <z13-doc-number>000023869</z13-doc-number>
      <z13-year>1950</z13-year>
      <z13-open-date>20040307</z13-open-date>
      <z13-update-date>20040307</z13-update-date>
      <z13-call-no-key/>
      <z13-call-no-code>LOC7</z13-call-no-code>
      <z13-call-no>Mus 783.10.601</z13-call-no>
      <z13-author-code>1001</z13-author-code>
      <z13-author>Pisk, Paul Amadeus, 1893-</z13-author>
      <z13-title-code>24510</z13-title-code>
      <z13-title>Sunset.</z13-title>
      <z13-imprint-code>260</z13-imprint-code>
      <z13-imprint>[New York, American Composers Alliance, 195-?]</z13-imprint>
      <z13-isbn-issn-code/>
      <z13-isbn-issn/>
      <z13-upd-time-stamp>201401051459091</z13-upd-time-stamp>
    </z13>
    <title-number>000023869</title-number>
    <imprint>[New York, American Composers Alliance, 195-?]</imprint>
    <title-of-article/>
    <pages-part/>
  </acq-request>
</get-pat-acq>
Cancel acquisition request example:
<?xml version ="1.0"encoding ="UTF-8"?><del-pat-acq><reply-text>ok</reply-text><reply-code>0000</reply-code><note type="info">Action Succeeded</note></del-pat-acq>

Possible Error Codes

01 : The supplied institution ID is invalid

02 : The patron ID is invalid

05 : Request does not belong to the requested patron

08 : Request does not exist

13 : Request cancellation failed