Parameters
OpenSearch parameters
| Parameter | Description | Required? | Possible Values |
|---|---|---|---|
| q | query in the form of a keyword search | required | keywords searched for records where all are present - OR - Use CQL |
| format | format of output | optional | rss, atom default is atom |
| start | start position | optional | default is 1 |
| count | maximum number of records to return top limit is 100 records | optional | default is 10 |
| cformat | the citation format you want to return | optional | apa, chicago, harvard, mla, turbian, all default is mla |
| servicelevel | Consult the Service Levels documentation to determine the differences in available indexes and displays between the two levels | optional for CQL queries only | default, full default is default |
| frbrGrouping | Whether or not to use FRBR grouping which groups together similar editions and present only the top held record as the representative record for that group. This is sometimes referred to as a "FRBRized" result set. To see separate records for editions, set this parameter to "off". | optional for CQL queries only | on, off default is on |
| wskey | Web Services Key | required |
SRU parameters
| Parameter | Description | Required? | Possible Values |
|---|---|---|---|
| query | query in the form of a CQL Search. For more information see the SRU Explain response | required | |
| recordSchema | determines the result format, and can be MARC XML (info%3Asrw%2Fschema%2F1%2Fmarcxml) or Dublin Core (info%3Asrw%2Fschema%2F1%2Fdc) | optional | info%3Asrw%2Fschema%2F1%2Fmarcxml
default is MARC XML info%3Asrw%2Fschema%2F1%2Fmarcxml |
| startRecord | the starting position of the result set | optional | default is 1 |
| maximumRecords | the maximum number of records to return in a single request top limit is 100 records per query | optional | default is 10 |
| sortKeys | specifies how the result is sorted | optional | relevance, Title, Author, Date, Library Count, or Score default sort key is relevance; relevance is only descending. default sort direction is "ascending"; to switch to descending add ",,0" to the sortKey. Separate combined sortKeys with a space; multiple values only works if frbrGrouping=off |
| frbrGrouping | whether or not to use FRBR grouping which groups together similar editions and present only the top held record as the representative record for that group. This is sometimes referred to as a "FRBRized" result set. To see separate records for editions, set this parameter to "off". | optional | on, off default is on |
| servicelevel | Consult the Service Levels documentation to determine the differences in available indexes and displays between the two levels | optional | default, full default is default |
| wskey | Web Services Key | required | |
Single Bibliographic Record parameters
| Parameter | Description | Required? | Possible Values |
|---|---|---|---|
| servicelevel | Consult the Service Levels documentation to determine the differences in available indexes and displays between the two levels | optional | default, full default is default |
| recordSchema | determines the result format, and can be MARC XML (info%3Asrw%2Fschema%2F1%2Fmarcxml) or Dublin Core (info%3Asrw%2Fschema%2F1%2Fdc) | optional | info%3Asrw%2Fschema%2F1%2Fmarcxml
default is MARC XML info%3Asrw%2Fschema%2F1%2Fmarcxml |
| wskey | Web Services Key | required | |
Library Location parameters
| Parameter | Description | Required? | Possible Values |
|---|---|---|---|
| location | location information:
| optional | postal codes provides library locations based on nearness to that postal code location for libraries within the countries Australia, Canada, France, Germany, Great Britain, the Netherlands, South Africa, and the United States. country name and ISO country code provides all holdings for all countries. default is IP address of the server, if no location or lat/long, or specified IP address |
| lat | latitude used with longitude to find libraries near those coordinates with holdings | optional | lat/long provides library locations based on nearness to that lat/long location for libraries within the countries Australia, Canada, France, Germany, Great Britain, the Netherlands, South Africa, and the United States. default is ip address of the server, if no location or lat/long, or specified IP address |
| lon | longitude used with latitude to find libraries near those coordinates with holdings | optional | lat/long provides library locations based on nearness to that lat/long location for libraries within the countries Australia, Canada, France, Germany, Great Britain, the Netherlands, South Africa, and the United States. default is ip address of the server, if no location or lat/long, or specified IP address |
| ip | specified IP address | optional | default is IP address of the server, if no location or lat/long, or specified IP address |
| startLibrary | start position | optional | default is 1 |
| maximiumLibraries | maximum number of libraries to show top limit is 100 libraries per query | optional | default is 10 libraries |
| libtype | type of library to limit holding results to | optional | 1 = academic, 2 = public, 3 = government, and 4 = other If no libtype parameter is sent then the system searches for holdings in all types of libraries |
| format | format of the response returned. Only use if want JSON response | optional | json |
| callback | JSON-P callback. Only used with JSON-P response format *Please do not embed your WSKey in client side javascripts* | optional | |
| frbrGrouping | whether or not to use FRBR grouping. The default option includes the library locations associated with any similar edition of the item requested. This is sometimes referred to as a "FRBRized" holdings results. To see holdings associated with only the single record requested set this parameter to "off". See the note on frbrGrouping information for Library Location documentation. | optional | on, off default is on |
| servicelevel | Consult the Service Levels documentation to determine the differences in available indexes and displays between the two levels | optional | default, full default is default |
| wskey | Web Services Key | required |
Library Catalog URL parameters
| Parameter | Description | Required? | Possible Values |
|---|---|---|---|
| oclcsymbol | OCLC Symbols to find holdings for. Can be a comma separated list of symbols. | required | To find symbols consult the Find an OCLC Library page |
| maximiumLibraries | maximum number of libraries shown top limit is 100 libraries per query | optional | default is 10 libraries |
| format | format of the response returned. Only use if want JSON response | optional | json |
| callback | JSON-P callback. Only used with JSON-P response format *Please do not embed your WSKey in client side javascripts* | optional | |
| frbrGrouping | whether or not to use FRBR grouping. The default option includes the library locations associated with any similar edition of the item requested. This is sometimes referred to as a "FRBRized" holdings results. To see holdings associated with only the single record requested set this parameter to "off". | optional | on, off default is on |
| servicelevel | Consult the Service Levels documentation to determine the differences in available indexes and displays between the two levels | optional | default, full default is default |
| wskey | Web Services Key | required |
Citation Format parameters
| Parameter | Description | Required? | Possible Values |
|---|---|---|---|
| cformat | the citation format you want to return | optional | apa, chicago, harvard, mla, turabian, or all default is MLA |
| wskey | Web Services Key | required |
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: