Using the API

Summary:

The purpose of the WMS Collection Management Service API is to allow institutions to access and manipulate their local holdings record (LHR) data in a consistent manner.

Access methods:

The URL endpoint for this service is determined in the following manner:

https://circ.sd00.worldcat.org/LHR/[copy_id]?inst=[institution_id] 

where [copy_id] is the copy ID and [oclc_number] is the oclc number of the work you want to retrieve copy information about.

https://circ.sd00.worldcat.org/LHR?q=oclcNumber:[oclc_number]&inst=[institution_id] 

where [institution_id] is the institution's WorldCat Registry ID and [oclc_number] is the oclc number of the work you want to retrieve copy information about.

To find out more of about the services available to this endpoint please consult the detail pages for  these resources:

• Copy resource

Response details:

To find out more of about the types of responses returned from this endpoint please consult the detail pages for these resources:

• Copy resource

Authentication:

Authentication for the WMS Collection Management API is handled using a WSKey v2.

Additionally, all requests to the API require that the principalID and principalIDNS parameters be included with the URI. ex:

?principalID=660ecd7d-3d1b-4433-abcd-ae843b716ec0&principalIDNS=urn:oclc:wms:da

This is necessary to identify the user who executes the request. It is also omitted in the examples for better readability.