OpenURL Resource

URL and Supported Request

The OpenURL supports two operations.

Operation Resource URL HTTP METHOD
Resolve http://worldcat.org/webservices/kb/openurl/resolve?rft.issn={ISSN}&wskey={API_Key} GET
Multiple Resolve http://worldcat.org/webservices/kb/openurl/mresolve?queries=(JSONObjectContainingQueries} GET

Response Formats

Parameters

Journal/Book Level Parameters

In order for a search to succeed, at least one of these is required

Parameter Definition

rft.title

Journal or book title

rft.issn

ISSN, can be comma delimited values to send more than one identifier per reqeust.

rft.eissn

e-ISSN

rft.isbn

ISBN, can be comma delimited values to send more than one identifier per reqeust.

rft.oclcnum

OCLC number, Journal level OCLC number - can be comma delimited values to send more than one identifier per reqeust.

Article Level Parameters

Article level information is used to identify a specific article within the journal. Most fields are not used directly by the API, but may be used to formulate an article link to give to the user. 

Parameter Required Definition

rft.date

No

Publication date, this will be used to filter out records that do not contain this date. Dates must be in the format YYYY, YYYY-MM, or YYYY-MM-DD

rft.volume

No

Journal volume, this will be used to filter out records that do not contain this volume. Volumes should be expressed as numbers only.

rft.issue

No

Journal issue, this will be used to filter along with volume. Issues should be expressed as numbers only.

rft.spage

No

Start page

rft.atitle

No

Article title

rft.aulast

No

First author's last name

WorldCat knowledge base API specific parameters:

These are parameters that are outside the normal OpenURL specifcation that can be used to send additional information or filter commands to the WorldCat knowledge base. They should be chosen based on the type of query being done.

Parameter Required Definition

svc_id

No

Select response format; possible values are: json and xml - defaults to json

rft.provider_uid

No

Provider uid as defined by knowledge base

rft.collection_uid

No

Collection uid as defined by knowledge base

rft.content

No

Indicator to select records of a specific content type; possible values are: fulltext, selectedft, abstracts, indexed, print, and ebook. Can be comma delimited values to send more than one identifier per reqeust. Defaults to full test

rft.institution_id

 

Library's worldcat registry ID

rft.jkey

No

Publisher's identifier for a journal

rft.openaccess

No

Open access flag; possible values are: none, yes, no. 'none' does not filter by the openaccess flag

rfr_id

No

 

A standard OpenURL referrer identifier.  It is used by clients to self identify similar to a User-Agent for HTTP requests. The format is:

info/sid:/

ex: info/sid:xyz.edu/OPAC

For example: WCRS uses info/sid:oclc.org/WCRS.

rft.id=info:doi...

No

Query by DOI. A DOI lookup will be done and result will be used to augment other query params

rft.id=info:pmid...

No

Query by PMID. A PMID lookup will be done and result will be used to augment other query params

rft.force_remote_lookup

No

Force PMID/DOI lookup. Normal behavior for DOI/PMID lookups is to only query when metadata is lacking. Setting rft.force_remote_lookup to 'yes' will make the lookup happen regardless of other metadata

Multiple Resolve Parameters

Parameter Required Definition Expected/Sample Value

queries

Yes

A JSON formatted set of OpenURL parameters

{
    "#QueryName#": {
        "#OpenURLParamenterName#": "#OpenURLParamenterValue#",
        "#OpenURLParamenterName#": "#OpenURLParamenterValue#",
        "#OpenURLParamenterName#": "#OpenURLParamenterValue#"
    },
    "#QueryName#": {
        "#OpenURLParamenterName#": "#OpenURLParamenterValue#",
        "#OpenURLParamenterName#": "#OpenURLParamenterValue#",
        "#OpenURLParamenterName#": "#OpenURLParamenterValue#"
    }
}

Notes

Coverage Fields

The coverage and coverage_enum fields provide information on the time period covered by the journal.

The format for the coverage field is the following:

content@startDate~endDate

The format for the coverage_enum field is the following:

content@volume:N;issue:N~volume:N;issue:N

where N is the value for the parameter before it.

Date ranges may also be specified using a "moving wall". The format for the moving wall is based on the XML duration standard and is used to specify periods of time. Example values include: P12M = 12 months ago, P2Y = 2 years ago, or P30D = 30 days ago, where P defines the value as a moving wall, the number indicates the amount of time units, and the following letter the time unit. 

Both fields can be open-ended, which means one or both of the range pairs can be omitted from the results.

Coverage Example Description

fulltext@1987

Fulltext starts in 1987

fulltext@1987~

Fulltext starts in 1987

fulltext@~1987 Fulltext ends in 1987
fulltext@1990~1997 Starts in 1990 and ends in 1997
fulltext@ No start / end date
fulltext@2003-06-01~P12M Starts on 06/01/2003 and ends 12 months ago
Coverage_enum Examples Description
fulltext@volume:1;issue:1~volume:14;issue:4 Starts Vol.1 Issue 1 and ends Vol. 14 Issue 4
fulltext@volume:57;issue:1~ Starts Vol. 57 Issue 1
abstacts No start and end identifiers for abstracts

Example URLs

Resolve Article

Article titled, Nature's Choices, found in Nature, 2010 Feb 18; 463(7283): 850 (http://www.worldcat.org/title/natures-choices/oclc/588264763&referer=brief_results).

GET http://worldcat.org/webservices/kb/openurl/resolve?rft.title=Nature&rft.issn=0028-0836&rft.oclcnum=1586310&rft.date=2010-02-18&rft.volume=463&rft.issue=7283&rft.spage=850&rft.atitle=Nature's+choices&svc_id=json&rft.content=fulltext&rfr_id=info/sid:library.edu/DEMO

Resolve Book

GET http://worldcat.org/webservices/kb/openurl/resolve?rft.isbn=9780596007652

Resolve Journal

GET http://worldcat.org/webservices/kb/openurl/resolve?rft.issn=1470-269X

Multiresolve

GET http://worldcat.org/webservices/kb/openurl/mresolve?queries={"queryForBook":{"rft.isbn":"9780596007652"},"queryForJournal":{"rft.issn":"0028-0836"}, "queryForArticle":{"rft.title":"Nature", "rft.issn":"0028-0836", "rft.oclcnum":1586310", "rft.date":"2010-02-18", "rft.volume":"463", "rft.issue":"7283", "rft.spage":"850", "rft.atitle":"Nature's+choices"}

We are a worldwide library cooperative, owned, governed and sustained by members since 1967. Our public purpose is a statement of commitment to each other—that we will work together to improve access to the information held in libraries around the globe, and find ways to reduce costs for libraries through collaboration. Learn more »