Holdings Resource

URLs and Supported Operations

The Holdings Resource supports 6 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
Batch Set - Multiple OCLC Numbers https://worldcat.org/ih/datalist?classificationScheme={scheme}&holdingLibraryCode={holdingCode}&oclcNumbers={Comma separated list of OCLC numbers}
POST 207
Batch Unset- Multiple OCLC Numbers https://worldcat.org/ih/datalist?classificationScheme={scheme}&holdingLibraryCode={holdingCode}&oclcNumbers={Comma separated list of OCLC numbers}&cascade={cascade flag} DELETE 207
Batch Set - Multiple Institutions https://worldcat.org/ih/institutionlist?classificationScheme={scheme}&holdingLibraryCode={holdingCode}&oclcNumber={OCLC number}&instSymbols={comma-separated list of client institution symbols} POST 207
Batch Unset- Multiple Institutions https://worldcat.org/ih/institutionlist?classificationScheme={scheme}&holdingLibraryCode={holdingCode}&oclcNumber={OCLC number}&instSymbols={comma-separated list of client institution symbols}&cascade={cascade flag} DELETE 207

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 (for set/unset single record) 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

oclcNumbers Yes (for batch set/unset holdings) A comma-separated list of OCLC Numbers to set/delete holdings on
instSymbols Yes (for batch set/unset holding for multiple instituions) A comma-separated list of institution symbols to set/delete a holding on.

Example URLs

Sets a holding on a record for the specified institution:

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

Removes a holding on a record for the specified institution:

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

Sets holdings on multiple records for the specified institution:

POST https://worldcat.org/ih/datalist?classificationScheme=LibraryOfCongress&holdingCode=OCPSB&oclcNumbers=426794447,8594968

Removes holdings on multiple records for the specified institution:

DELETE https://worldcat.org/ih/datalist?classificationScheme=LibraryOfCongress&holdingCode=OCPSB&oclcNumbers=426794447,8594968&cascade=1

Sets a holding on a specific record for the specified institutions:

POST https://worldcat.org/ih/institutionlist?classificationScheme=LibraryOfCongress&holdingCode=OCPSB&oclcNumber=426794447&instSymbols=TUC,YSY

Removes a holding on a specific record for the specified institutions:

DELETE https://worldcat.org/ih/institutionlist?classificationScheme=LibraryOfCongress&holdingCode=OCPSB&oclcNumber=426794447&instSymbols=TUC,YSY&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

Merged Records

  • Set holdings and delete holdings using a merged OCLC number will result in the operation being performed using the record which the merge OCLC Number is now part of.

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 »