Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WorldCat Local Holdings Resources API

The Local Holdings Resources API from WorldCat — 3 operation(s) for local holdings resources.

WorldCat Local Holdings Resources API is one of 20 APIs that WorldCat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Local Holdings Resources. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 22 schemas. It is described by OpenAPI 3.0.2, at version 1.0.6.

Requests are made against a single base URL, https://id.oclc.org/worldcat.

3 operations 3 paths 22 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.6
Base URL
https://americas.discovery.api.oclc.org/worldcat/search/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

WorldCat Local Holdings Resources API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (entity_data_auth) using the clientCredentials and authorizationCode flows, exposing 2 scopes.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Local Holdings Resources 3
GET
/worldcat/search/v2/my-holdings/{controlNumber}
Retrieve LHR Resource
retrieve-lhr 2 params → 200400404405406500
GET
/worldcat/search/v2/my-holdings
Search LHR Resources
search-lhr 6 params → 200400405406500
GET
/worldcat/search/v2/retained-holdings
Search for shared print LHR Resources
search-retrained-lhr 10 params → 200400405406500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are HoldingPart (14 properties), HoldingDetail (13 properties), SharedPrintCommitment (11 properties), CallNumber (9 properties). Each schema is shown below with its type and property counts.

SharedPrintCommitment
object
11 properties
HoldingPart
object
14 properties
DisplayCallNumber
string
Display call Number [LHR - v852 |k,h,i,m / |j/ |l]
HoldingDetail
object
13 properties 7 required
SublocationCollection
string
Sublocation or collection [LHR - v852sb]
PieceDesignation
string
Piece Designation [852/863-865/866-868/876-878 |p]
OclcNumber
integer
the oclc number of a given bibliographic record
Problem
object
RFC 7807 description of an error.
5 properties
OCLCSymbol
string
institution OCLC Symbol. Special characters need to be encoded properly.
CallNumber
object
Local call number [LHR - v852sh,i,j,k,l,m]
9 properties
ProblemType
string
A URI reference [RFC3986] that identifies the problem type.
SummaryOfHoldings
string
Summary of Holdings [https://www.loc.gov/marc/holdings/echdcntf.html]
RegistryId
integer
The identifier in the WorldCat Registry for the institution
HasSharedPrintCommitment
string
institution has shared print commitment [Holdings/LibHasSharedPrint || LHR - HldDetRec/Admin/SPReg]
HoldingLocation
object
Local holding location [LHR - v852sa,b,c]
3 properties
TextualHoldingsStatement
string
[866-8 |a]
HoldingResultSet
object
2 properties
HoldingRange
object
2 properties
MaterialSpecified
string
[876-8 |3]
ShelvingLocation
string
Shelving location [LHR - v852sc]
CaptionValuePair
object
The caption and value pair for a caption describing a numeric, alphabetic, and/or date designation for an item. The caption is defined as an attribute on the e…
2 properties
TemporaryLocation
string
Temporary location [876-878 |l]

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldcat-local-holdings-resources-api-openapi.yml Raw ↑

Other APIs WorldCat publishes across the network.

WorldCat Knowledge Base API
WorldCat Bibliographic Resources API
WorldCat Local Bib Resources API
WorldCat Manage Bibliographic Records API
WorldCat Manage Institution API
WorldCat Manage Local Bibliographic Data API
WorldCat Manage Local Holdings Records API
WorldCat Member Enabled Collections API
WorldCat Member Enabled Providers API
WorldCat Member Enabled Title by OpenURL API
WorldCat Member Enabled Titles API
WorldCat Member Enabled Titles by OpenURL API