WorldCat
Advanced Search
My Account Logout Get E-mail Updates
WorldCat » WorldCat Affiliate tools » xISBN (Web service) » xOCLCNUM » xOCLCNUM API

xISBN (Web service)

Use this Web service to map book-related identifiers (ISBN, LCCN, OCLC number), based on WorldCat information. Free and subscription versions are available.

xOCLCNUM API

Overview

The xOCLCNUM API is similar to xISBN API. The request can be a single OCLC number or LCCN (Library of Congress Control Number), and response is always organized by OCLC records. Most xISBN conventions are applicable to xOCLCNUM as well, such as different flavors of dissemtation format, and JSON callback feature. However xOCLCNUM supports different set of method and metadata fields. In this document we only list noticeable differences between xOCLCNUM and xISBN API.

When the request is about a known OCLC number, the xOCLCNUM service endpoint URL is:

      http://xisbn.worldcat.org/webservices/xid/oclcnum/
    
When the request is about a known LCCN number, the xOCLCNUM service endpoint URL is:
      http://xisbn.worldcat.org/webservices/xid/lccn/
    
When the request is about a known OCLC workid, the xOCLCNUM service endpoint URL is:
      http://xisbn.worldcat.org/webservices/xid/owi/
    

For example, to request all editions of [Learning Python], request is:

http://xisbn.worldcat.org/webservices/xid/oclcnum/54619668?method=getEditions&format=xml&fl=lccn,owi,isbn

The response is an XML formatted message similar to this example.

    	<rsp xmlns="http://worldcat.org/xid/oclcnum/" stat="ok">
	<oclcnum isbn="9780596002817" lccn="2004273129" owi="owi718389">54619668</oclcnum>
	<oclcnum isbn="9781565928930" owi="owi718389">44960325</oclcnum>
	<oclcnum isbn="9781565924642" lccn="00267609" owi="owi718389">41466161</oclcnum>
    	</rsp>
      

To issue same request with LCCN, request is:

http://xisbn.worldcat.org/webservices/xid/lccn/2004273129?method=getEditions&format=xml&fl=lccn,isbn,owi
To issue same request with workid, request is:

http://xisbn.worldcat.org/webservices/xid//owi/owi718389?method=getEditions&format=xml&fl=lccn,isbn,owi

Search in a library

This feature limits search scope to a particular library's holding, we also treat any collections as a library in general. Current support value includes:

Request

xOCLCNUM now supports three methods: getVariants ,getEditions and getMetadata.

Supported identifier format

  • oclcnum: xOCLCNUM accepts oclcnums in different flavor, such as 5584725, ocl705584725, ocm05584725, (OCoLC)5584725
  • lccn: xOCLCNUM normalizes LCCN according to LCCN Namespace, however we do not handle LCCN with Suffix/Alphabetic Identifier and Revision Date, a client is expected to strip off these information before making an LCCN query. For example, 79-310919 works, but 79-310919//r86 or 79-310919%2F%2Fr86 won't work

getVariants

This service returns different variants of an OCLC number. Please see OCLC Technical Bulletin 253 for possible variants of an OCLC number.

	http://xisbn.worldcat.org/webservices/xid/oclcnum/54619668?method=getVariants&format=xml
      

The response is an XML formatted message similar to this example.

      <rsp xmlns="http://worldcat.org/xid/oclcnum/" stat="ok">
      	   <oclcnum scheme="plain">5584725</oclcnum>
	   <oclcnum scheme="marc:001:pre1981">ocl705584725</oclcnum>
	   <oclcnum scheme="marc:001">ocm05584725</oclcnum>
	   <oclcnum scheme="marc:035">(OCoLC)5584725</oclcnum>
	   <oclcnum scheme="infouri">info:oclcnum/5584725</oclcnum>
      </rsp>
      

getEditions

This service returns a list of relevant OCLC numbers and requested metadata fields.

	http://xisbn.worldcat.org/webservices/xid/oclcnum/54619668?method=getEditions&format=xml&fl=lccn,isbn
      

The response is an XML formatted message similar to this example.

    	<rsp xmlns="http://worldcat.org/xid/oclcnum/" stat="ok">

	<oclcnum isbn="9780596002817" lccn="2004273129">54619668</oclcnum>
	<oclcnum isbn="9781565928930">44960325</oclcnum>
	<oclcnum isbn="9781565924642" lccn="00267609">41466161</oclcnum>
    	</rsp>

      

getMetadata

This service returns metadata information about requested OCLC number.

	http://xisbn.worldcat.org/webservices/xid/oclcnum/54619668?method=getMetadata&format=xml&fl=*
      

The response is an XML formatted message similar to this example.

	<?xml version="1.0" encoding="UTF-8"?>
    	<rsp xmlns="http://worldcat.org/xid/xoclcnum/" stat="ok">
		<oclcnum isbn="9780596002817" lccn="2004273129" owi="owi718389">54619668</oclcnum>
    	</rsp>
      

Response in details

Metadata fields

If the request is valid, xOCLCNUM service returns a list of matched OCLC numbers and requested metadata fields, with a "stat=ok" indication.

A number of metadata fields can be associated with an OCLC number:

  • lccn: Library Of Congress Control Number
  • isbn: ISBN number
  • owi: OCLC workid
  • presentOclcnum: present OCLC number. Only used when the response OCLC number is obsolete.
  • url: URL link to electronic resource

Deleted and merged OCLCNUM

Worldcat uses OCLC Control Number Cross-Reference to track deleted OCLC numbers. When an OCLC number is deleted, it's still search-able from this service. In the response, we use presentOclcnum to specify present OCLC number. For example 2416076 was merged into 24991049, a request of the deleted number 2416076 will return:

      <rsp xmlns="http://worldcat.org/xid/xoclcnum/" stat="ok">
      <oclcnum lccn="34025476" presentOclcnum="24991049">2416076</oclcnum>
      </rsp>
    

The presentOclcnum field is omitted when an OCLC number is active, so request to current OCLC number 24991049 returns:

      <rsp xmlns="http://worldcat.org/xid/xoclcnum/" stat="ok">
      <oclcnum lccn="34025476" >24991049</oclcnum>
      </rsp>