Search Functionality
Search Functionality
The Search functionality follows the Library of Congress' SRU CQL syntax and supports several configurable parameters which can be embedded in the command. See the SRU CQL syntax for full details. The basic usage of the Web service is as follows:
<Web Service Base URL> "&query=" <Query> ["+or+"|"+and+" <Query>]
Where:
<Web Service Base URL> | = | the base URL of the WorldCat Registry Search Web service: http://worldcat.org/webservices/registry/search/Institutions? |
<Query> | = | <term> "%22" <value> "%22" |
The Query supports any/all of the following terms, where each term represents a searchable field in the WorldCat Registry:
| <Web Service Base URL> | = | the base URL of the WorldCat Registry Search Web service: http://worldcat.org/webservices/registry/search/Institutions? |
| <Query> | = | <term> "%22" <value> "%22" |
The Query supports any/all of the following terms, where each term represents a searchable field in the WorldCat Registry:
| 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. This term is included in name searches for completeness. |
| 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 |
Usage Examples
This URL provides an example of the WorldCat Registry Search Web service searching for all public libraries in Columbus, Ohio::
http://worldcat.org/webservices/registry/search/Institutions?version= 1.1&operation=searchRetrieve&recordSchema= info%3Arfa%2FrfaRegistry%2FschemaInfos%2FadminData&maximumRecords= 10&startRecord=1&resultSetTTL=300&recordPacking=xml&query= local.city+%3D+%22columbus%22+and+local.libTypeUser+exact+%223%22+and+ local.state+exact+%22US-OH%22&x-info-6-deletedRecord=
This URL provides an example of the WorldCat Registry Search Web service searching for all public libraries in Texas that have the string "Baylor" within their name:
http://worldcat.org/webservices/registry/search/Institutions?version= 1.1&operation=searchRetrieve&recordSchema= info%3Arfa%2FrfaRegistry%2FschemaInfos%2FadminData&maximumRecords= 10&startRecord=1&resultSetTTL=300&recordPacking=xml&query= local.oclcAccountName+all+%22baylor%22+or+local.institutionName+all+%2 2baylor%22+and+local.libTypeUser+exact+%223%22+and+local.state+exact+% 22US-TX%22&x-info-6-deletedRecord=
Syntax for Logically Deleted Records
A logically deleted record is designated in the XML record within the <institution> element by the presence of the logicalDelete="yes" attribute.
<institution logicalDelete="yes">
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: