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 Manage Institution API

The Manage Institution API from WorldCat — 9 operation(s) for manage institution.

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

Tagged areas include Manage Institution. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 9 paths, and defines 12 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.

9 operations 9 paths 12 schemas 4 GET5 POST

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 Manage Institution 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 9

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

Manage Institution 9
GET
/worldcat/manage/institution/holdings/current
Retrieve the current institution holdings for Bibliographic records from WorldCat.
get-current-holdings 1 param → 200400401403406500
POST
/worldcat/manage/institution/holdings/set
Set a holding on a Bibliographic record.
set-a-holding body → 200400401403404406500
POST
/worldcat/manage/institution/holdings/unset
Unset a holding on a Bibliographic record.
unset-a-holding 1 param body → 200400401403404406500
POST
/worldcat/manage/institution/holdings/{oclcNumber}/set
Set the holding on a Bibliographic record for an institution by OCLC Number.
set-holding-for-one-or-multiple-institutions 1 param → 200400401403404406500
POST
/worldcat/manage/institution/holdings/{oclcNumber}/unset
Unset the holding on a Bibliographic record for an institution by OCLC Number.
Unset-holding-for-one-or-multiple-institutions 2 params → 200400401403404406500
POST
/worldcat/manage/institution/holdings/move
Move a holding from one Bibliographic record to another.
move-holdings body → 200400406409
GET
/worldcat/manage/institution/holding-codes
Retrieve Holding Codes
retrieve-holding-codes → 200401403404406500
GET
/worldcat/manage/institution-config/branch-shelving-locations
Retrieve branch holding codes and shelving locations
manage-institution-branch-config 3 params → 200400401403405406500
GET
/worldcat/search/institution
Fetch Identifiers for an Institution
find-institution-by-identifier 3 params → 200400401403405406500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are BranchLocations (8 properties), InstitutionBranchConfig (6 properties), Problem (5 properties), MoveHoldings (2 properties). Each schema is shown below with its type and property counts.

MoveHoldings
object
Move holdings for an institution
2 properties
schemas-OclcNumber
integer
the oclc number of a given bibliographic record
SourceOclcNumber
string
The holding library symbol to move from
MARCXML
object
see https://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd
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.
InstitutionBranchConfig
object
6 properties
BranchLocations
object
8 properties
RegistryId
integer
The identifier in the WorldCat Registry for the institution
TargetOclcNumber
string
The holding library symbol to move to
ProblemType
string
A URI reference [RFC3986] that identifies the problem type.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

worldcat-manage-institution-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 Local Holdings Resources API
WorldCat Manage Bibliographic Records 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