OCLC Developer Network

OpenURL Response

Following is an abbreviated example of the JSON and XML responses from the following query:

http://worldcat.org/webservices/kb/openurl/resolve?rft.title=Nature&wskey=...

JSON

[
    {
        "uid": "948189",
        "openaccess": "yes",
        "issn": "1749-4915",
        "provider_uid": "freeAccess",
        "institution_id": [
            "111637"
        ],
        "collection_name": "Open Journal Systems - Public Knowledge Project",
        "url": "http://www.equinoxjournals.com/ojs/index.php/JSRNC",
        "oclcnum": "186383811",
        "content": "fulltext",
        "id": "b8a1ac05e563bc24c83b48c668f414f6",
        "title": "Journal for the Study of Religion, Nature and Culture",
        "linkerurl": "http://link.worldcat.org/?rft.institution_id=111637&pkgName=ojs&issn=1749-4915&linkclass=to_article&jKey=www.equinoxjournals.com%2Fojs%2Findex.php%2FJSRNC&provider=freeAccess
&title=Journal+for+the+Study+of+Religion%2C+Nature+and+Culture&linkScheme=ojs
&jHome=http%3A%2F%2Fwww.equinoxjournals.com%2Fojs%2Findex.php%2FJSRNC&wskey=…&linktype=best",
        "jsid": "96432",
        "coverage_enum": "fulltext@volume:10;issue:1~volume:5;issue:2",
        "coverage": "fulltext@2005~2011",
        "oclcnums": "612806357 186383811 457245449",
        "jkey": "www.equinoxjournals.com/ojs/index.php/JSRNC",
        "collection_uid": "freeAccess.ojs",
        "provider_name": "Free Access Content"
    },
    {
        "uid": "5631324",
        "openaccess": "yes",
        "issn": "1179-1608",
        "provider_uid": "DOAJ",
        "institution_id": [
            "111637"
        ],
        "collection_name": "Directory of Open Access Journals (All titles)",
        "url": "http://www.dovepress.com/nature-and-science-of-sleep-journal",
        "publisher": "Dove Medical Press",
        "oclcnum": "535520478",
        "content": "fulltext",
        "id": "b793c362c40a4b1400e3405b7d5e3a56",
        "title": "Nature and Science of Sleep",
        "jsid": "96116",
        "coverage_enum": "fulltext",
        "coverage": "fulltext@2010",
        "oclcnums": "535520478 695988944",
        "collection_uid": "DOAJ.Records",
        "provider_name": "Directory of Open Access Journals"
    },

....
}

Please note: The WSKey used to generate this example was redacted from the result.

 

XML

To invoke the XML response the svc_id=xml should be included:

http://worldcat.org/webservices/kb/openurl/resolve?rft.title=Nature&svc_id=xml&wskey=...

which yields the following output:

<rsp>
	<record uid="948189" openaccess="yes" issn="1749-4915" provider_uid="freeAccess" 
		institution_id="111637" collection_name="Open Journal Systems - Public Knowledge Project" 
		url="http://www.equinoxjournals.com/ojs/index.php/JSRNC" oclcnum="186383811" content="fulltext" 
		id="b8a1ac05e563bc24c83b48c668f414f6" title="Journal for the Study of Religion, Nature and Culture" 
		linkerurl="http://link.worldcat.org/?rft.institution_id=111637&pkgName=ojs&issn=1749-4915&linkclass=to_article&jKey=www.equinoxjournals.com%2Fojs%2Findex.php%2FJSRNC&provider=freeAccess&title=Journal+for+the+Study+of+Religion%2C		+Nature+and+Culture&linkScheme=ojs&jHome=http%3A%2F%2Fwww.equinoxjournals.com%2Fojs%2Findex.php%2FJSRNC&wskey=…&linktype=best" 
		jsid="96432" coverage_enum="fulltext@volume:10;issue:1~volume:5;issue:2" coverage="fulltext@2005~2011" 
		oclcnums="612806357 186383811 457245449" jkey="www.equinoxjournals.com/ojs/index.php/JSRNC" collection_uid="freeAccess.ojs" provider_name="Free Access Content"
	/>

	<record uid="5631324" openaccess="yes" issn="1179-1608" provider_uid="DOAJ" institution_id="111637" 
		collection_name="Directory of Open Access Journals (All titles)" url="http://www.dovepress.com/nature-and-science-of-sleep-journal" publisher="Dove Medical Press" 
		oclcnum="535520478" content="fulltext" id="b793c362c40a4b1400e3405b7d5e3a56" 
		title="Nature and Science of Sleep" jsid="96116" coverage_enum="fulltext" coverage="fulltext@2010" 
		oclcnums="535520478 695988944" collection_uid="DOAJ.Records" provider_name="Directory of Open Access Journals"
	/>
	...
	
</rsp>

Please note: The WSKey used to generate this example was redacted from the result.

 

Multiple requests per query

Example URL:

http://worldcatqa.dev.oclc.org/webservices/kb/openurl/mresolve?queries={"q2":{"rft.issn":"0028-0836"}, "q1":{"rft_id":"info:pmid/17014720"}}

Response:

{
  
	"q2" : {
     
		 "result" :  [
      {
        "uid":"359506",
        "openaccess":"no",
        "issn":"0028-0836",
        "provider_uid":"NPG",
        "institution_id":[
          "105357"
        ],
        ....
    ]
	
  },
  
	"q1" : {
   
		 "result" :  [
      {
        "uid":"951320",
        "openaccess":"no",
        "issn":"1471-2105",
        "provider_uid":"BMC",
        "institution_id":[
          "6569"
        ],
        "collection_name":"BMC Journals",
        "oclcnum":"48656745",
        "content":"fulltext",
        "id":"f359ef7dea1719e60c08648610531562",
        "title":"BMC Bioinformatics",
        "jsid":"26126",
        "coverage_enum":"fulltext",
        "coverage":"fulltext@2000",
        "oclcnums":"48656745",
        "collection_uid":"BMC.journals",
        "provider_name":"BioMedCentral"
      },
      {
        "uid":"951505",
        "openaccess":"yes",
        "issn":"1471-2105",
        "provider_uid":"BMC",
        "institution_id":[
          "105357",
          "6569",
          "86024"
        ],
        "collection_name":"BMC Journals (Open Access Content only)",
        "oclcnum":"48656745",
        "content":"fulltext",
        "id":"73f0a54a98b17b0177e16c7a7860773f",
        "title":"BMC Bioinformatics",
        "jsid":"26126",
        "coverage_enum":"fulltext",
        "coverage":"fulltext@2000",
        "oclcnums":"48656745",
        "collection_uid":"BMC.openAccess",
        "provider_name":"BioMedCentral"
      }
    ]	
  }
}

Space delimited lists

Some of the response types are able to return space delimited lists. These include the oclcnums, coverage, and contents fields. ex:

"oclcnums": "612806357 186383811 457245449",
"coverage_enum": "fulltext@volume:343;issue:6253 abstracts indexed"
"coverage": "fulltext@1990-01-04~P365D abstracts@1986-01-02 indexed@1986-01-02"

 

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. Ex:

 

coverage examples

DESCRIPTION

fulltext@1987

Fulltext starts in 1987

fulltext@1987~

Fulltext starts in 1987

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

Follow the OCLC Developer Network:

The OCLC Developer Network supports the use of OCLC Web Services—a set of tools and APIs that expose data and services for WorldCat and our member libraries and partner institutions or companies. learn more »

© 2010 OCLC Domestic and international trademarks and/or service marks of OCLC Online Computer Library Center, Inc. and its affiliates


Powered by Drupal, an open source content management system