WorldCat Knowledge Base API - REST Response - Collections

Search a library's collections

Request:

http://worldcat.org/webservices/kb/rest/collections/search?q=Proquest&start-index=1&max-results=2&order-by=title&institution_id=105357&wskey=...

Response:

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:os="http://a9.com/-/spec/opensearch/1.1/">
	<os:totalResults>1403</os:totalResults>
	<os:startIndex>5</os:startIndex>
	<os:itemsPerPage>2</os:itemsPerPage>
	<os:Query role="REQUEST" searchTerms="order-by=title"/>
	<entry xmlns:kb="http://wordcat.org/kbwc">
		<collection_uid>ProQuest.acad18</collection_uid>
		<title type="text">ABI/INFORM Dateline</title>
		<link href="http://worldcat.org/kbwc-grid/rest/collections/ProQuest.acad18" rel="self"/>
		<link href="http://worldcat.org/kbwc-grid/rest/collections/ProQuest.acad18" rel="edit"/>
		<kb:provider_uid>ProQuest</kb:provider_uid>
		<kb:provider_name>ProQuest (Legacy Platform)</kb:provider_name>
		<kb:owner_institution>6569</kb:owner_institution>
		<kb:source_institution>6569</kb:source_institution>
		<kb:status>raw</kb:status>
		<kb:available_entries>100</kb:available_entries>
		<kb:selected_entries>100</kb:selected_entries>
		.....
</feed>

Response options:

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 likehttp://example/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=edit	Same value as id
link@rel=via	Identifies a resource that is the source of the information in the link's context.
provider_uid	Identifier for a provider
provider_name	Name of the Provider
available_entries	Number of available entries in a collection
selected_entries	Number of selected entries in a collection
collection_name	Name of the Collection
collection_uid	Identifier for a collection
owner_institution	The institution that has their holdings on the collection
source_institution	The institution that originally added the collection to the KB (6569 corresponds to OCLC)
status	Status, possible values for Entries are raw, copy, and overlay, possible values for Collections are raw, copy, select, and empty.
dbkey	Database specific identifier used by the content provider (useful for making article links)
source	Source of this particular holding (used by automated data feed loading process).
open	Whether the collection is readable to everyone
collection_type	Some basic attributes of a collection, possible values are: openaccess, browsable...
wcsync_enabled	Worldcat sync_enabled or not
ext	Internal extension defined by Knowledge Base

REST Response - Collections

API Documentation