Service Guides for HoldingsIQ

Investigate use cases. Find sample scenarios. Learn how your applications can best use HoldingsIQ.

Populating Holdings Data

Before you can download a set of customer holdings, you need to populate the holdings data to a staging area.

To Populate Holdings Data (example):

Request

POST https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/holdings

Note: You do not need to send a JSON object in the request body.

Response

202 ACCEPTED

If your request to populate holdings has been accepted for processing, a 202 is returned. The 202 is an indication that your request has been accepted, but the processing has not been completed. If a snapshot is currently in progress, a 409 is returned.

Customers can make changes such as removing a title, selecting a title or hiding a title in their holdings at any time. If a customer has made holdings changes since the last time that the holdings data was populated to the staging area, you need to re-stage the data with a fresh POST request. The fresh POST request ensures that you have all of the latest changes reflected in the holdings data staging area. Re-staging the data with a fresh POST request will wipe out the previously staged data. It will be replaced with a fresh holdings snapshot. Changes in publication level metadata in the Knowledge Base do not require another population of the holdings data in order to capture the metadata changes in the holdings download. Typically, it takes around 30-45 seconds to create a snapshot for around 1.5 million titles.

For more information on the POST holdings resource, please refer to our interactive or service reference documentation.