Holdings Resource

URLs and Supported Operations

The Holdings Resource supports 2 operations for setting and unsetting a libraries holdings.

Operation Resource URL HTTP Method Response Code
Set/Create https://worldcat.org/ih/data?classificationScheme={scheme}&holdingLibraryCode={holdingCode}&oclcNumber={OCLC number}&cascade={cascade flag} POST 201
Unset/Delete https://worldcat.org/ih/data?classificationScheme={scheme}&holdingLibraryCode={holdingCode}&oclcNumber={OCLC number}&cascade={cascade flag} DELETE 200

HTTP Accept Types

The Holdings Resource will return a small, empty document when successful responses are made.

HTTP Request Content Types

The Holdings Resource does not require clients to send a payload in the request body.

Parameters

Parameter Required? notes
oclcNumber Yes OCLC Number of the record to set/delete holdings on
inst No

Registry ID of the institution whose holdings are being set on the record

Either this parameter or the instSymbol are required

instSymbol No

OCLC Symbol of the institution whose holdings are being set on the record

Either this parameter or the inst are required

classificationScheme Yes  
holdingLibraryCode No Four letter holding code to set the holding on. Valid codes for a given institution can be obtained via a request for holding code resource
cascade Yes (for delete operations only)

Whether or not to execute the operation if a local holdings record, or local biblliographic record exists.

0 - don't remove holdings if local holding record or local bibliographic record exists

1 - yes remove holdings and delete local holdings record or local bibliographic record exists

Example URLs

Sets holdings for the specified institution:

POST https://worldcat.org/ih/data?classificationScheme=LibraryOfCongress&holdingCode=OCPSB&oclcNumber=426794447

Removes holdings for the specified institution:

DELETE https://worldcat.org/ih/data?classificationScheme=LibraryOfCongress&holdingCode=OCPSB&oclcNumber=426794447&cascade=1

Notes

  • When sending a Set/Create request for a holding that already exists, the API will respond with an HTTP 409 response code
  • When sending an Unset/Delete request for a holding that does not exist, the API will respond with an HTTP 409 response code

We are a worldwide library cooperative, owned, governed and sustained by members since 1967. Our public purpose is a statement of commitment to each other—that we will work together to improve access to the information held in libraries around the globe, and find ways to reduce costs for libraries through collaboration. Learn more »