Provider Resource

URLs and Supported Requests

The Provider Resource supports two operations.

Operation Resource URL HTTP METHOD
Search http://worldcat.org/webservices/kb/rest/providers/search?q={query}&start-index=1&max-results=10&order-by=title GET
Read http://worldcat.org/webservices/kb/rest/providers/{Provider_ID} GET

Response Formats

Parameters

Parameters 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

Yes

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:

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

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

title=NPG

No

title match (keyword)

title="NPG"

No

exact title match

title="NPG%"

No

starts with title match

provider_uid=

No

Exact provider uid match

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

Provider 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 likehttp://example/providers/NPG defined earlier. The ID value is important and must return the canonical format.

title

Provider name

link@rel=self

Same value as id, just to be standard compliant

link@rel=alternative

The url of the HTML version of the provider resource

link@rel=via

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

provider_uid

Identifier for a provider

vic_id Identifier for the provider in the Vendor Information Center

provider_name

Name of the Provider

available_collections

Number of available collections in a provider

selected_collections

Number of selected collections in a provider

available_entries Number of available entries in a provider
selected_entries Number of selected entries in a provider

Example URLs

Returns a list of all providers (this will the providers in use by the institution associated with the WSKey):

GET http://worldcat.org/webservices/kb/rest/providers/

Returns information about the provider with the id NPG:

GET http://worldcat.org/webservices/kb/rest/providers/NPG

Searches the providers for the one title that contains "Nature":

GET http://worldcat.org/webservices/kb/rest/providers/search?title="Nature%"

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 »