Using the API

Summary:

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

Access methods:

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

https://circ.sd00.worldcat.org/pulllist/[branch_id]?inst=[institution_id]

where [branch_id] is the WMS ID for the branch and [institution_id] is the institution's WorldCat Registry ID.

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

• Pull list 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:

• Pull list resource

Authentication:

Authentication for the WMS Circulation 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.