REST Response - Providers
Search a library's providers
Request:
http://worldcat.org/webservices/kb/rest/providers/search?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>5</os:totalResults> <os:startIndex>1</os:startIndex> <os:itemsPerPage>2</os:itemsPerPage> <entry xmlns:kb="http://wordcat.org/kbwc"> <provider_uid>ProQuest</provider_uid> <available_collections>10</available_collections> <selected_collections>1</selected_collections> ..... </entry> <entry xmlns:kb="http://wordcat.org/kbwc"> <provider_uid>NPG</provider_uid> <available_collections>10</available_collections> .... </entry> </feed>
The "available_entries" and "selected_entries" describes the number of entries in global kb and number of entries selected by the library.
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_collections | Number of available collections in a provider |
selected_collections | Number of selected collections in a provider |
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
Follow the OCLC Developer Network: