Response Details

Status codes

Possible status code includes:

• ok: correct request and response
• unknownField: the request field is not supported
• unknownFormat: the request format is not supported
• unknownId: the request identifier looks like a valid ISBN number and unknown to xISBN service
• unknownLibrary: the request library is not supported
• unknownMethod: the request method is not supported
• invalidId: the request identifier is not a valid ISBN number
• overlimit: the request is throttled, only header is returned
• invalidAffiliateId: invalid affiliate id
• invalidHash: invalid hash (subscription only)
• invalidToken: invalid access token (subscription only)

Valid conditions and 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, such as:

<?xml version="1.0" encoding="UTF-8"?>
<rsp xmlns="http://worldcat.org/xid/isbn/" stat="ok">
<isbn title="Learning Python" form="BA" year="2004" lang="eng" ed="2nd ed." author="Lutz, Mark." publisher="O'Reilly">0596002815</isbn>
</rsp>

Invalid and exception conditions

If the request is invalid or the usage has reached limits, the response will return header only, with appropriate status code. For example, a request to

http://xisbn.worldcat.org/webservices/xid/oclcnum/12345678901234

returns following response:

<?xml version="1.0" encoding="UTF-8" ?>
	<rsp xmlns="http://worldcat.org/xid/oclcnum/" stat="invalidId"/>
      

Metadata Fields

A number of metadata fields can be associated with an Identifier when responding to the getEditions or getMetadata method:

• lccn: Library Of Congress Control Number, this field is space-delimited if multiple values exist.
• oclcnum: OCLC number, this field is space-delimited if multiple values exist.
• owi: OCLC Work ID
• presentOclcnum: present OCLC number. Only used when the response OCLC number is obsolete.
• url: URL link to electronic resource

XML schema for response XML

The XML schema in xisbn.xsd validates xISBN response XML format.

CSV, TEXT, JSON, Python, Ruby, PHP, and XHTML response

Several other serialization formats are supported. Below is an example of each:

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

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

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

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

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

http://xisbn.worldcat.org/webservices/xid/oclcnum/55847258?method=getMetadata&fl=*&format=csv (comma-delimited file)

http://xisbn.worldcat.org/webservices/xid/oclcnum/55847258?method=getMetadata&fl=*&format=txt (tab-delimited file)