Service Guides for HoldingsIQ

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

Retrieving Holdings Snapshot Status

After you have placed a request to populate customer holdings data (POST /{custid}/holdings), you can retrieve the status of the holdings snapshot. The status of the holdings snapshot can be in progress, completed, not staged (none) or failed. You can only download a set of customer holdings when the status of the holdings snapshot is completed.


To Check the Status of a Holdings Snapshot (example):

Request

GET https://sandbox.ebsco.io/rm/rmaccounts/CUSTID/holdings/status

Response


200 OK

{ "status": "Completed", "created": "2017-09-19 13:43:34.207", "totalCount": 7 }

When the “status” element in the response becomes “Completed”, the customer holdings data has been populated to a staging area and the customer holdings are ready to be downloaded.

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