OCLC Developer Network

Request Types

Overview

FAST has four request types you can use to access the API

 

Linking by FAST Identifier

To link to a resource using the FAST identifier, a call should use the following URL pattern:

http://id.worldcat.org/fast/{identifier}/{format}.xml

where identifier is the requested identifier and format is either HTML, RDF, or MARC21.

 

AutoSuggest

To complete an autosuggest search, plese use the following URL pattern:

http://fast.oclc.org/searchfast/fastsuggest?query={query}&fl={facet}&rows={rows}&wt=json&json.wrf={callback}

where each query parameter is defined as follows:

query parameterexplanation
queryThe text to be queried against AutoSuggest. Use quotation marks if it contains spaces
rowsThe maximum number of results. Default = 10, Maximum = 20
flThe facet to be searched. Default = suggestall. See the table below for a complete listing.
wt and json.wrfUsed only if json.wrf is used to invoke a jsonp reposnse.

 

Facets that can be searched

Facet / SOURcesearchindex
All Facetssuggestall
Personal Namessuggest00
Corporate Namessuggest10
Eventssuggest11
Titlessuggest30
Topicalssuggest50
Geographicssuggest51
Formssuggest55
LC Headingrefphrase

 

OpenSearch

To complete an open search call against the API, please use the following URL pattern:

http://fast.oclc.org/fast/search?query=cql.any+all+%22{query}%22&httpAccept={httpAccept}&maximumRecords={rows}&startRecord={startRecord}&sortKey={sortKey}

where each query parameter is defined as follows:

query parameterexplanation
queryThe text to be queried against. ex. "cats"
httpAcceptUse application/xml for MARC21 xml, application/rdf+xml for RDF
maximumRecordsThe number of records to return per page. ex. 10
startRecordThe record to start with. ex. 1
sortKeyusage is the only sort key currently supported.

 

SRU

To complete a SRU call against the API, please use the following URL pattern:

http://id.worldcat.org/fast/search?query=cql.any+all+%22{query}%22&httpAccept={httpAccept}&maximumRecords={rows}&startRecord={startRecord}&sortKey={sortKey}

Where the query parameter are the same as above except that {query} is a SRU query as part of the OpenSearch query. SRU offers the following indexes (for a complete listing consult http://id.worldcat.org/fast/search):

indexdescription
Cql.allKeywords in all headings
oclc.topicKeywords in topical headings
oclc.geographicKeywords in geographical headings
oclc.eventNameKeywords in event headings
oclc.personalNameKeywords in personal headings
oclc.corporateNameKeywords in corporate name headings
oclc.uniformTitleKeywords in uniform title headings
oclc.periodKeywords in period headings
oclc.formKeywords in form headings
oclc.altlckeywords in LC Source headings
oclc.headingFull headings
oclc.subphraseSubfield
oclc.seeAlsophraseFull see also headings
oclc.lcphraseLC Source headings
oia.identifierFAST Authority Record Number (ARN)
oclc.faststatusRecord status
oclc.establishLevel of establishment
oclc.geocodeGeographic area code (GAC)
oclc.featureGeographic Feature
oclc.lcnumberLCCN for LC Source Headings

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