Organization Resource

URL and Supported Request

The Organization Resource supports four operations.

Operation Resource URL HTTP METHOD
LookUp http://www.worldcat.org/webservices/registry/{serviceLevel}/Institutions/{WorldCat_Registry_ID} GET
SRUSearch http://www.worldcat.org/webservices/registry/search/Institutions?recordSchema=info%3Arfa%2FrfaRegistry%2FschemaInfos%2FadminData&query={CQL_Query} GET
LookupBySymbol http://www.worldcat.org/webservices/registry/lookup/Institutions/oclcSymbol/{OCLCSymbol}?serviceLabel={serviceLabel} GET
FindALibrary http://www.worldcat.org/libraries/geosearch{format}?lat={latitude}&long={longitude}&radius={radius}&units={unitOfDistance} GET

Response Formats

LookUp

SRUSearch

  • application/xml

LookupBySymbol

FindALibrary

URL Tokens

LookUP URL Tokens

Name Description
serviceLabel

Required: The level of detail to return in the response.

 

  • content
  • enhancedContent - This contains the same information as content plus the institution's OpenURL resolvers

 


FindALibrary URL Tokens

Name Description
format

Optional: The format to return the response in.

  • .xml
  • .json

Parameters

SRU Parameters

Name Description
query A CQL query of the WorldCat Registry fields. See SRU Query Indices for possible indexes
recordSchema

The schema to return the WorldCat Registry records in.

Must be set to - info%3Arfa%2FrfaRegistry%2FschemaInfos%2FadminData

startRecord  
maximiumRecord  

SRU Query Indices

This resource supports any/all of the following terms, where each term represents a searchable field in the WorldCat Registry:

Index Description
local.oclcAccountName This is the account name at OCLC, which is not visible in the WorldCat Registry interface. This may or may not match the marketing name typically used to refer to the institution.
local.institutionName This is the Institution Name displayed in the WorldCat Registry interface.
local.institutionAlias This is the Alias (an "also known as" name for the institution) displayed in the WorldCat Registry interface.
local.libTypeUser This is the Institution Type displayed in the WorldCat Registry interface. This is a numeric value that utilizes the following key:

1    ARL Library
2    Academic Library
3    Public Library
4    School Library
5    Other (Corporate or Special Library)
6    State or National Library
7    Library Networks or Processing Center
8    Government Library (except State or National Library)
11   Vendor
13   Museum
14   Archives
15   Regional Service Provider
16   Correctional Facility Library
17   Dental Library
18   Hospital Library
19   Law Library
20   Medical Library
21   Music Library
22   Nursing Library
23   Veterinary Library
999 Unknown
local.country This is the two-character Country Code, per ISO 3166.
local.city This is the name of the City.
local.state This is the name of the State/Province, per ISO 3166-2.
local.postalCd This is the Postal Code.
local.regID This is the WorldCat Registry ID, which is the unique and persistent numeric identifier assigned to an institution's profile in the WorldCat Registry.
local.oclcSymbol This is the OCLC Symbol, an alphabetic and/or numeric identifier assigned to an institution that participates in the OCLC cooperative.
local.marcOrgCode This is the alphabetic U.S. MARC Organizational Code
local.san This is the Standard Address Number (SAN)
local.ncesId For U.S. libraries, this is the alphabetic and/or numeric National Center for Education Statistics (NCES) Identifier
local.au search by Australian National Union Catalog:
A unique identifier issued by the National Library of Australia for organizations which contribute information to the Australian National Bibliographic Database (ANBD)
e.g. ANL
local.nzLibSymbol search by New Zealand Library Symbol:
A unique library identifier issued by the National Library of New Zealand. Its primary purpose is to facilitate interloan, e.g.WN for National Library of New Zealand, Wellington.
e.g. WN
local.ISIL search by International Standard Identifier for Libraries (ISIL):
A unique identifier issued by the ISIL Agency.
local.logicalDelete Limit to records that are not deleted. Deleted records have a 1 in this field

LookupBySymbol Parameters

Name Description
serviceLabel

Required: The level of detail to return in the response.

  • content
  • enhancedContent - This contains the same information as content plus the institution's OpenURL resolvers

Find A Library Parameters

Geolocation request with radius:

  • Exactly one of the following parameters is specified: long + lat, postalCode, ip
  • Radius and units both apply (defaults are used if omitted from the request)
  • A countryCode OR stateCode may be supplied. If so, the results are filtered to include entries only in those locations regardless of radius.

Country or state only request:

  • Only a countryCode or stateCode are supplied. If both are supplied, the countryCode should match the state code or else zero results are likely.
  • Radius and units do not apply.
  • The search results will return libraries in the state/country in alphabetical order by name. The response will not contain a distance value.
Parameters Required Description
long No longitude (-180 thru 180)
lat No latitude (-90 thru 90)
postalCode No The postal code/zip
ip No An IP address to use to determine geolocation
countryCode No The invalid link: http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.htmlISO-3166 A2 country code (e.g. US)
stateCode No The invalid link: http://www.iso.org/iso/en/prods-services/iso3166ma/04background-on-iso-3166/iso3166-2.htmlISO-3166-2 state/province code (e.g. US-OH)
radius No The radius in miles/kilos etc, valid values: 1-100, default=20
units No The units for the radius ("miles", "kilos", "nauticalmiles"), default=miles
instTypes No Comma separated list of institution type integers to include (e.g. 1,10,18)
omitInstTypes No Comma separated list of institution type integers to omit (e.g. 2,12)
wskey Yes An OCLC web service key
maximumRecords No Integer - Maximum record to retrieve, valid values: 1-100, default=20
startRecord No Integer - The starting record number to retrieve, default=1

Look Up Responses

Schemas for Responses

Fields Description
totalRecords total number of records returned
parameters parameters sent to the search
institution the institution retrieved
institution/identifier Institution identifier in OCLC Registry
institution/name name
institution/phonenumber Phone Number
institution/address adress
institution/address/street Name of street
institution/address/state Name of State
institution/address/postalCode Postal code
instituion/address/countryName Country Name spelled out
institution/address/longitude longitude
institution/address/latitude latitude
institution/oclcSymbols institution OCLC Symbol (repeatable for institutions with more than one symbol

 

SRU Search Response Fields

An SRU response contains a subset of the Registry fields:

  • Library Alias
  • Library name
  • Library Type
  • Street Address
  • City
  • State
  • Zip
  • Country

Schema for SRU response

Find A Library Response Fields

Fields Description
totalRecords total number of records returned
parameters parameters sent to the search
institution the institution retrieved
institution/identifier Institution identifier in OCLC Registry
institution/name name
institution/phonenumber Phone Number
institution/address address
institution/address/street Name of street
institution/address/state Name of State
institution/address/postalCode Postal code
instituion/address/countryName Country Name spelled out
institution/address/longitude longitude
institution/address/latitude latitude
institution/oclcSymbols institution OCLC Symbol (repeatable for institutions with more than one symbol

Example URLs

Retrieve details about of an institution with the WorldCat Institution Registry ID of 2320 :  

GET http://www.worldcat.org/webservices/registry/content/Institutions/2320

GET http://www.worldcat.org/webservices/registry/enhancedContent/Institutions/2320

Retrieve details of an institution with the OCLC symbol of TUC:

GET http://www.worldcat.org/webservices/registry/lookup/Institutions/oclcSymbol/TUC?serviceLabel=content

GET http://www.worldcat.org/webservices/registry/lookup/Institutions/oclcSymbol/TUC?serviceLabel=enhancedContent

Search for all public libraries in Columbus, Ohio:

GET http://worldcat.org/webservices/registry/search/Institutions?recordSchema=info%3Arfa%2FrfaRegistry%2FschemaInfos%2FadminData&query=local.city+%3D+%22Columbus%22+and+local.libTypeUser+exact+%223%22+and+local.country+exact+%22US%22
+and+local.state+exact+%22US-OH%22+not+local.logicalDelete%3D%221%22

Search for all public libraries in Texas that have the string "Baylor" within their name:

GET http://worldcat.org/webservices/registry/search/Institutions?version=1.1&operation=searchRetrieve
&recordSchema=info%3Arfa%2FrfaRegistry%2FschemaInfos%2FadminData&query=local.institutionName+all+%22baylor%22+and+local.libTypeUser+exact+%223%22
+and+local.country+exact+%22US%22+and+local.state+exact+%22US-TX%22
+not+local.logicalDelete%3D%221%22

Search for all the libraries within a 30 mile radius of Madison, WI (43.073465,-89.40112):

GET http://www.worldcat.org/libraries/geosearch.xml?lat=43.073465&long=-89.40112&radius=30&units=miles&wskey=[yourkey]

GET http://www.worldcat.org/libraries/geosearch.json?lat=43.073465&long=-89.40112&radius=30&units=miles&wskey=[yourkey]

Search for all the public libraries within the state of Rhode Island:

GET http://www.worldcat.org/libraries/geosearch.xml?countryCode=US&stateCode=US-RI&instTypes=3&wskey=[yourkey]

GET http://www.worldcat.org/libraries/geosearch.json?countryCode=US&stateCode=US-RI&instTypes=3&wskey=[yourkey]

Notes

Authentication

Generally operations on these resources are do not require authentication. The exception to this is the FindALibrary operations which uses WSKey Lite.

 

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 »