null

OASIS CHECK AVAILABILITY & PRICING API

OVERVIEW

This document will help ProQuest OASIS customers prepare their Alma system for use with the Check Availability & Pricing API. The Check Availability & Pricing API will allow communication between OASIS and the customer’s Alma system to search for titles in OASIS and obtain stock and pricing information for print titles (firm orders and print DDA).
The setup process will involve configuration on both the Alma and OASIS systems. Information will need to be obtained from ProQuest and some information configured in Alma as well.
The API will allow customers to configure Alma to show OASIS as a vendor, and search stock/pricing and order titles via OASIS without leaving the Alma platform.

INTRODUCTION

The OASIS Check Availability & Pricing API is a web service that can be used to determine availability for a given ISBN in the OASIS catalog via a programmatic script.

All requests to the ordering API require an API key. This key ensures the identity of the request and is used to track API usage.
Before invoking this process make sure the account set up process has been discussed with customer service and set up internally
All requests are limited to print items only - this process does not support eBooks availability.
All requests to the OASIS Check Availability & Pricing API are required to be made over a secure connection. If the incoming connection is not secure, then the API will return an error.

API Key

Before Alma can complete a Check Availability & Pricing call to OASIS, it must be provided an API Key by OASIS. 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 Check Availability & Pricing API:

Customers located in North America, Australia, and New Zealand should contact academicsupport@proquest.com
Customers located in the United Kingdom, Ireland, and Europe should contact customerserviceuk-reps@proquest.com

Set Up

Every institution defines its vendors. OASIS is treated as a vendor in Alma. Library can set the name for OASIS as they see fit. We can recommend name (“OASIS”), but library will enter the name and code manually. The library decides.
Every vendor has at least 1 account. This is usually set up by type of material ordering (serials, etc.) as there is payment information, etc. in the account. Institution will need to complete the vendor profile (fields required to fill out?)-how payment is to be made, terms, etc.
Go to System Integration tab under vendor. Select Availability and Pricing under System Integration Attributes.
Choose System Type = OASIS
Enter API key provided by OASIS in Connection Parameters.
Then connection to OASIS is set up.

Search

From Acquisitions menu in Alma, choose Check Availability and Pricing from under the Purchase Request heading.

Go to Check Availability and Pricing

Rota tab will display all vendors defined with integrations for library along with partners for resource sharing.
Select vendor to search (OASIS). Enter search criteria. Click Go in top right.
Will display count of records. If only 1 title, it will display pricing.
Click on 3 ellipses to Review Results or Place Order

View External Vendor will take user directly into OASIS. If not already logged in to OASIS, user will be prompted to enter user name and password.

Order

Create order (from Alma) creates the order in Alma following usual process. Library may want to set up OASIS templates for Purchase Orders
- Price is not carried over from search. Needs to be entered manually. It is required for all types except gift, technical or exchange. Most libraries enter an estimated price to encumber funds within Alma.
- If the search result is only one title (such as when searching by ISBN), user can choose order to order directly from Alma.
- Order then follows usual Alma process rules (for reviewing), not OASIS rules.

If vendor does not have EDI to OASIS-Alma set up, then an email will be sent to OASIS

Performing a Check Availability & Pricing

Using the parameters listed in a further section below, the user will need to build a Check Availability & Pricing URL and place into a browser window. Accessing the URL will return a message that will indicate OASIS availability for the title.

Sample Run

The URL to invoke the Check Availability & Pricing API is:
https://0-oasis--services-proquest-com.library.cairn.edu/stockcheck?apiKey=<value>&ISBN=<value>
In the test environment, oasis-services.proquest.com would be substituted with oasis-services-alpha.proquest.com

Parameters

Field Name	API Key Name	Description
API Key	apiKey	The customer's unique API Key as provided by ProQuest
ISBN	ISBN	The 10 digit ISBN number for the requested title

Sample Return

Non-Stocked Item

API CALL:

http://0-oasis-services-alpha.proquest.com.library.cairn.edu/stockcheck/?apiKey=a1833bbc-0c55-4dd6-a64a-8463bbd49427&ISBN=080614839x

RETURN:

{"Environment":"Alpha","RequestEnd":"\/Date(1453761996840-0600)\/","RequestStart":"\/Date(1453761981801-0600)\/","Code":0,"DeliveryDays":"14","Message":"OASIS Accepts Orders"}

Stocked Item

API CALL:

http://0-oasis-services-alpha.proquest.com.library.cairn.edu/stockcheck/?apiKey=a1833bbc-0c55-4dd6-a64a-8463bbd49427&ISBN=0806148373

RETURN:

{"Environment":"Development","RequestEnd":"\/Date(1558557900157+0000)\/","RequestStart":"\/Date(1558557899140+0000)\/","Code":0,"DeliveryDays":"4","Message":"In Stock"}

Unsuccessful Return

If an error is encountered, the returned value will look like:

Condition	Error Code	Example Return Value
Missing Parameter	200	{"Code":200,"Message":"<error text>"}
Error	400	{"Code":400,"Message":"<error text>"}

The field ‘error text’ can be inspected and logged to determine the extent of the problem.