Entry Resource

URLs and Supported Requests

The Entry Resource supports two operation.

Operation Resource URL HTTP METHOD
Search http://worldcat.org/webservices/kb/rest/entries/search?q={query} GET
Read http://worldcat.org/webservices/kb/rest/entries/{Entry_ID} GET

Response Formats

Parameters

Parameter Required Description

alt

No

Alternate representation type. Alternative means of setting the representation type instead of the Accept header. Supported values include

  • xml - return a application/xml representation
  • json - return a application/json representation

Default value is xml

wskey

No

The client key for accessing this service

itemsPerPage

No

Maximum number of results to retrieve. Default value 10

q

No

Full-text query string.

startIndex

No

1-based index of the first result to be retrieved. Default value 1

orderBy

No

Expression for sorting a collection of results. The format is ?order-by= . Ascending / descending order is specified by appending “asc” or “desc”.

Examples:

  • /entry?order-by=title desc
  • /entry?order-by=relevancy

Default value "title asc", possible sorting criteria are: title, relevancy, holdings, preference, issn, isbn, oclcnum

title=Nature

No

title match (keyword)

title="Nature"

No

exact title match

title="Nature%"

No

starts with title match

issn=

No

ISSN match

isbn=

No ISBN match

oclcnum=

No

OCLC number match

search-type=

No

"atoz": atoz type of query, it must be used in combination with startswith title search, and the returned result will every title search in combination with "a,b,...z". For example, if Title query is "a%", the result shall include aa, ab,,.. query result.

"search": search only. Default: "search"

provider_uid=

No

Exact provider uid match

collection_uid=

No

Exact collection_uid match

content= No Indicator to select records of a specific content type; possible values are: fulltext, selectedft, abstracts, indexed, print, and ebook.

callback=

No

JSON callback when the alt is json. This will be implemented when JSON serialization format is finalized.

institution_id

No

This field must be supplied if the user is authorized to multiple institutions, otherwise the value should be obtained by authorization

 

Entry Response Fields

The following table lists all the available response options - XML serialization is Atom based and JSON serialization is based on JAXB. Both XML and JSON serialization should use same attribute names defined below.

Attribute Description

totalResults

Total number of search results for the query (not necessarily all present in results feed)

startIndex

The 1-based index of the first result

itemsPerPage

The maximum number of items that appear in one page. This allows clients to generate direct links to subsequent pages.

Query

Echo the original request

link@rel=atoz/title=aa/length=##

Link to a-z list, the title field indicates the starting letter(s), and length is corresponding result size of each letter.

id

The id of the resource, it should take the URI format like http://worldcat.org/webservices/kb/rest/providers/NPG defined earlier. The ID value is important and must return the canonical format.

title

Provider and collection name, and entry title.

link@rel=self

Same value as id, just to be standard compliant

link@rel=alternate

URL for the entry in HTML

link@rel=via

Identifies a resource that is the source of the information in the link's context.

link@rel=enclosure URL to download KBART file for this entry

collection_name

Name of the Collection

collection_uid

Identifier for a collection

status

Status, possible values for Entries are raw, copy, and overlay, possible values for Collections are raw, copy, select, and empty.

oclcnum

OCLC number of a matching bib in WorldCat

entry_uid

Persistent identifier for a title level record (may not be present if the record has no persistent identity)

jkey

Vendor defined journal id

bkey

Vendor defined book id

isbn

Book ISBN

issn

ISSN

eissn

eISSN

coverage

Coverage in date format

coverageenum

Coverage enumeration in volume/issue format

publisher

Publisher

author

Author

ext

Internal extension defined by Knowledge Base

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

Returns a title about record "NPG.journals,1987357,105357":

GET http://worldcat.org/webservices/kb/rest/entries/NPG.journals,1987357,105357

Searches 105357's holdings for issn 0000-0000:

GET http://worldcat.org/webservices/kb/rest/entries/search?institution_id=105357&issn=0000-0000

Returns institution 105357's subscription to entry 123 in NPG.journals:

GET http://worldcat.org/webservices/kb/rest/entries/search?institution_id=105357&entry_uid=123&collection_uid=NPG.journals

To do an A-Z list search using numeric characters:

GET http://worldcat.org/webservices/kb/rest/entries/search?title="100%"&start-index=1&max-results=0&institution_id=105357&search_type=atoz&

To retrieve all entries of a library:

GET http://worldcat.org/webservices/kb/rest/entries/?institution_id=105357

 

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 »