null

OASIS REAL TIME ACQUISITIONS API

OVERVIEW

This document will help ProQuest OASIS customers prepare their Alma system for use with the Real Time Acquisitions (or Ordering) API to allow communication between OASIS and the customer’s Alma system to insert purchase order lines as items are ordered in OASIS.
The setup process will involve configuration on both the Alma and OASIS systems.  Information will need to be obtained from the ExLibris developer’s website and information will need to be sent to ProQuest.
The API will create the order line in the Purchase Order as well as create a brief bibliographic record which may be used in the OPAC or discovery systems.  That record is very brief. We highly recommend that you be set up to do a nightly load of “brief” MARC records from ProQuest OASIS to overlay those records to provide better access.
ExLibris calls this process RTO or Real Time Acquisitions and has also has documentation at https://developers.exlibrisgroup.com/blog/Real-time-Acquisitions.

INTRODUCTION

The OASIS Real Time Acquisitions API is a web service that can be used to order any title in the OASIS catalog via a programmatic script. Note: a software developer with basic-to-intermediate skill level may be required to write the code to invoke the OASIS Real Time Acquisitions API.

API Key

All requests to the OASIS Real Time Acquisitions API require an API key. This key is unique per customer and should not be shared or distributed to anyone outside of your organization.
To obtain this key, the system administrator must contact OASIS customer service to request the OASIS Real Time Acquisitions API key:

Ordering

The OASIS Real Time Acquisitions API requires the API key and a series of parameters as defined in your account setup at ProQuest.
The OASIS Real Time Acquisitions API is invoked via a REST call, whereby the parameters are defined as key-value pairs.

Required Parameters

API KeyThe apiKey value as supplied by ProQuest. This value to follow in a separate email and is a unique identifier.
ISBNISBN of the title being ordered in ISBN10 or ISBN13 format
QuantityTotal order quantity

Optional Parameters

Field NameAPI Key NameData TypeDescription
Order Type   OrderTypeString2 applicable values:
  1. RatificationOrder – request is created in OASIS on specific ratification list awaiting authorization
  2. CouttsOrder – order is created directly.
Field NameAPI Key NameData TypeDescription
Customer Purchase Order NoCustPONoStringCustomer supplied purchase order Number for this order
Budget/Fund CodeBudgetStringCustomer supplied Fund or Budget number for this order
Site / LocationSiteStringCustomer supplied Site/Location code for this order
Loan Type/StockLoantypeStringCustomer supplied Loan Type or Stock category for this order
CollectionCollectiStringCustomer supplied Collection code
Order Email AdminOemadmStringOrder administration email address for notification
Order Email End UserOemendStringOrder end-user email address for notification
Duplication OverrideDupeoverBooleanCustomer acknowledges that the order is a duplicate and if set then in OASIS will ignore the duplication checks: Yes/No
Phone RushPhoneRushBooleanPhone rush flag
Internal NoteIntNotesStringCustomer Internal notes
Notes to CouttsCouNotesStringNotes to Coutts customer services (Vendor notes)
Additional CopyAddcopyBooleanTreat this order as additional copy
BindingBindingStringBinding of the ISBN on order
Branch CodeBranchcdStringBranch code
ClassificationCclassnoStringCustomer supplied Classification
 
Field NameAPI Key NameData TypeDescription
Faculty MemberFacmembStringCustomer end user identification
Patron IDpatronidStringCustomer patron ID
Holding CodeholdingStringCustomer holding code
Interdisc. SubjectintrdiscStringInterdisc. Subject
Item TypeitemtypeStringItem Type
Material TypemattypeStringMaterial Type
BarcodenbarcodeBooleanOASIS to apply Barcode to item
ProcessingnprocBooleanOASIS to process item
MARC Record ReqnreqmrBooleanMARC Record cataloguing required
Spine Label ReqnreqsplBooleanspine label required
Order CategoryordcatStringCustomer order category
Receiving ActionrecactStringAction required at customer receipt
Readers Interest CategoryricStringReader Interest Category
Rotation CoderotcodeStringPublic Library rotation code
Sequence CodeseqcodeStringCustomer sequence code
ShelfmarkshelfmkStringShelfmark
Size CodesizecodeStringIndicates oversized material
 

Rest Call

Parameters are passed to the ordering API via a REST call. The call would appear as follows:

Production Environment

https://oasis-services.proquest.com/order?apiKey=<value>&ISBN=<value>&Quantity=<value>& OrderType=<value>&<API Key Name #1>=<value #1>& <API Key Name #2>=<value #2>& <API Key Name #3>=<value #3>…& <API Key Name #x>=<value #x>

Test Environment

https://oasis-services-alpha.proquest.com/order?apiKey=<value>&ISBN=<value>&Quantity=<value>& OrderType=<value>&<API Key Name #1>=<value #1>& <API Key Name #2>=<value #2>& <API Key Name #3>=<value #3>…& <API Key Name #x>=<value #x>

Sample API

https://oasis-services.proquest.com/order?apiKey= 68f27cb2-1bc5-4ddd-96d9-f01581115501&ISBN=9781234567890&Quantity=1& OrderType=CouttsOrder&CustPONo=CN38383& Intnotes=description%20of%20internal%20notes& Oemadm=abc@couttsinfo.com

Successful

If successful, the returned value will look like:
{"Code":100,"Message":"Success"}

Unsuccessful

If an error is encountered, the returned value will look like:
ConditionError CodeExample Return Value
Missing Parameter200{"Code":200,"Message":"<error text>"}
Error400{"Code":400,"Message":"<error text>"}
 The field "error text" can be inspected and logged to determine the extent of the problem.