Ready to Learn?Ex Libris products all provide open APIs

New ACQ Request per Title

General Purpose

The resource may be accessed with a GET method to retrieve the needed ACQ request parameters for a specific patron and title.
The ACQ request information includes the reason and order information that the patron may submit when creating a Title-level ACQ request.

The resource may be accessed with a PUT method to create a new ACQ request for a specific patron and on a specific Title.

For creating a totally new ACQ request on non existing title, please refer to the "New Blank ACQ Reques" page.


Product Version Compatibility

Versions 22.01 and later.


Interface Type

RESTful API

 

Hierarchy

Slide20_patrons-patron_id-records-acq_req

Input Parameters

REST Resource IDs:

Patron ID: The Aleph patron system identifier.

Record ID: The Aleph BIB record identifier. The identifier is composed of the BIB library code + the system number. For example, USM01000050362

Item ID: The Aleph item record identifier. The item ID may be used to fetch a specific item's information. The identifier is composed of the ADM library code + the item record key. For example, USM50000238843000320.


Input URI

<Base URL>:patron/<patron ID>/record/<record ID>/acqRequest

For example:

To submit an ACQ request for a specific BIB record 000000300  and for the patron ID 00000036, use:

http://server.name:1892/rest-dlf/patron/00000036/record/USM01000000300/acqRequest


Input XML

To submit an ACQ request for a specific BIB record and patron, use the same URL with a PUT method of HTTP.
The request "Body" of the "PUT" method must contain input XML with the ACQ request details.


The PUT XML must have the following structure:

post_xml=<?xml version="1.0" encoding="UTF-8" ?><get-rec-acq> <acq_parameters allowed="Y"> <reason>I need it</reason> <order-group>Art Dep</order-group> </acq_parameters> </get-rec-acq>

 (The "post_xml="  is mandatory).

Output XML Format

If a new request was successfully created using the PUT method, a reply such as the following will be reported:

<?xml version="1.0" encoding="UTF-8"?>
<put-rec-acq>
  <reply-text>ok</reply-text>
  <reply-code>0000</reply-code>
  <create-acq-request>
    <note type="info">Action Succeeded</note>
  </create-acq-request>
</put-rec-acq>

Possible Error Codes

0002    The patron ID is invalid.
0019    Record does no exist
0025    Failed to create request
0029    Patron is not privileged
0028    Match records found