OCLC Developer Network

REST Request - Settings

Building a query:

The purpose of the Settings service is to provide developers with the ability to retrieve information about a specific institution within the WorldCat Knowledge Base.

The basic URL structure of the service is the following:

http://worldcat.org/webservices/kb/rest/settings/{instid}

 

Example queries:

Please note: As with most OCLC APIs, this service requires the use of a WSKey, which has been removed from the examples below.

EXAMPLE URLNOTES
http://worldcat.org/webservices/kb/rest/settings/105357 Returns institution information about institution 105357.

 

Query options:

These are the standard Open Platform Data Protocol query options available through the WorldCat Knowledge Base API (all of them are optional):

PARAMETER

DESCRIPTION

alt

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

The client key for accessing this service

institution_id

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

 

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