Request a New Export File of Holdings Data

Before you can download a set of customer holdings, an export file of holdings data needs to be created. The export files of holdings data can be accessed by export id. If an export file already exists of your desired holdings data, you do not need to request that an export file be created. You can retrieve the details about the exports of your holdings using the GET /{custid}/exports endpoint.

To Create a New Export File of Holdings Data (example):

Request

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

Response

202 ACCEPTED

{
  "custId": "testid",
  "id": "096dea08-c57e-4dc5-a984-51a99830ffff",
  "type": "STANDARD",
  "fileName": "testExport_standard_csv",
  "status": "QUEUED",
  "created": "2023-06-01T19:31:40.241315Z",
  "format": "CSV"
}

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. 

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 holdings data export file was created, you need to create a new holdings data export file with a fresh POST request. The fresh POST request ensures that you have all of the latest changes reflected in the holdings data export file. 

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