Tech Blog

How to see an example of how the New Order API integration profile defines and finds a match on an existing record in five easy steps

In this blog post we will show that the New Order API integration profile is designed to match on an ISBN.

We will then see that when a new order is created the order is attached to an existing bibliographic record if one exists with the same ISBN as in the input.

As supplementary material see also:

How to create an order via an API in your institution in 5 easy steps
Using multiple New Order API integration profiles

ONE

We have two integration profiles of type “New Order API”

TWO

See that “E Zafrani New Order API: matches on
     A. ISSN Match Method (exact subfield match)
     B. ISBN Match Method (exact subfield match)

THREE

See that we have in our repository a record with the following
     A. Title: Kentucky women: their lives and times
     B. ISBN: 9780820347523
     C. MMSID: 99220310400121

FOUR

The input for the new order API will be as follows. Note the ISBN in the resource_metadata section.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<po_line>
<number></number>
<status></status>
<owner desc="Main Library">ULINC</owner>
<type desc="Electronic Title - One Time">ELECTRONIC_TITLE_OT</type>
<vendor desc="J and S Ltd. (Formerly &quot;Johnson and Smith Ltd.&quot;)">JS</vendor>
<vendor_account>JS_MAIN</vendor_account>
<acquisition_method desc="Purchase">PURCHASE</acquisition_method>
<rush>false</rush>
<cancellation_restriction>false</cancellation_restriction>
<price>
<sum>10.0</sum>
<currency desc="US Dollar">USD</currency>
</price>
<vendor_reference_number>
</vendor_reference_number>
<vendor_reference_number_type>Null</vendor_reference_number_type>
<source_type desc="Manual Entry">MANUALENTRY</source_type>
<po_number></po_number>
<invoice_reference>
</invoice_reference>
<resource_metadata>
<mms_id></mms_id>
<title>Kentucky women : their lives and times</title>
<author>McEuen, Melissa A</author>
<isbn>9780820347523</isbn>
<publisher>University of Georgia Press</publisher>
<publication_place>Athens</publication_place>
<publication_year>2015</publication_year>
<vendor_title_number>
</vendor_title_number>
<system_control_numbers>
<system_control_number>
</system_control_number>
</system_control_numbers>
</resource_metadata>
<fund_distributions>
<fund_distribution>
<fund_code desc="Library and Information Science">LIS</fund_code>
<amount>
<sum>10.0</sum>
<currency desc="US Dollar">USD</currency>
</amount>
</fund_distribution>
</fund_distributions>
<reporting_code>y</reporting_code>
<secondary_reporting_code>arg</secondary_reporting_code>
<tertiary_reporting_code>s</tertiary_reporting_code>
<vendor_note>
</vendor_note>
<receiving_note>
</receiving_note>
<alerts>
<alert></alert>
</alerts>
<notes/>
<locations/>
<license desc="">
</license>
<url>null</url>
<base_status>
</base_status>
<access_provider>JS</access_provider>
<manual_renewal>false</manual_renewal>
<renewal_cycle/>
<renewal_period>0</renewal_period>
<material_type desc="Book">BOOK</material_type>
<created_date></created_date>
<status_date></status_date>
</po_line>

FIVE

Do a POST as follows. Note that it uses the New Order API integration profile E_Zafrani_New_Order_API which we saw above which matches by “ISBN Match Method (exact subfield match)”:

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/acq/po-lines?profile_code=E_Zafrani_New_Order_API&apikey=01234567890

In the Body choose application/xml and put in the xml from above.
Get response with POL number and MMSID.  See that it is the POL-45512 and MMSID 99220310400121 which is the existing MMSID we saw above:

You will see that if you search Alma the new POL has been connected to the existing bibliographic record and a new one was not created:

Leave a Reply