OCLC Developer Network

Request Types

Direct Linking by QuestionID

http://questionpoint.org/crs/servlet/org.oclc.ask.AskPatronFetchQAWS?qid=[questionID]&type=[format]

Example

Linking to QuestionID 44960

http://questionpoint.org/crs/servlet/org.oclc.ask.AskPatronFetchQAWS?qid=44960&type=xml

Search

http://questionpoint.org/crs/servlet/org.oclc.kb.KBSearchWS?&andk=[searchTerms]&preflang=[language]&kbids=[knowledgebaseID]&kbids=[knowledgebaseID]&type=[format]

Search Parameters

 
ParameterExplanation
 
andk = term (use + between multiple words in a term)All words must appear in the record.
 
phk = term.All words must appear exactly in the order typed.
 
ork = term.Any of the words typed must appear in the record.
 
notk = term.Must be used with one of the above. Find records without this word(s)
 
preflang = language code for the search term

(see Language codes section below)

This determines the analyzer used.
 
kbids = number of the KB to searchThe Global KB is 1. See Admin module for local KB number.
 
dr = code for date rangeLast Week (lw)

Last Month (lm) Last Three Months (lt) Last Six Months (ls) Last Year (ly)

 
lang = language code of retrieved records See Language codes below
 
sopt = kwUse this to search the Keyword field only.
 
qcat = category code See Category Codes below
 
topsubject = letterLetter representing the highest level in the LC Class System
 
qinst = institution ID numberLimit results to questions asked at a particular institution*
 
ainst = institution ID numberLimit results to questions answered at a particular institution*
 
num = 10Number of questions per page; also 20, 30, 50, 100)
 
typeRepsonse Format 

*It is assumed that most users will not be concerned about at which institution a question was posed or which institution answered the question. If you are searching only your local KB, the parameter may not apply at all. Contact your administrator or that of the desired institution for institution IDs.

Category Codes

  • 1 = FAQ
  • 2 = Bibliography/Pathfinder
  • 3 = Research (3)
  • 4 = Ready Reference (4)
  • 5 = Community Information (5)

Language Codes

 
LanguageCode
 
Arabic1
 
Chinese2
 
Dutch3
 
English4
 
French5
 
German6
 
Hebrew7
 
Hindi8
 
Hungarian9
 
Italian10
 
Japanese11
 
Korean12
 
Polish13
 
Portuguese14
 
Russian15
 
Sanskrit16
 
Spanish17
 
Swedish18
 
Turkish19
 
Ukrainian20
 
Danish21
 
Norwegian22
 
Slovenian23
 
Afrikaans24
 
Ndebele25
 
Northern Sotho26
 
Southern Sotho27
 
Swazi28
 
Tsonga29
 
Tswana30
 
Venda31
 
Xhosa32
 
Zulu33
 
Greek34
 
Czech35
 
Finnish36
 
Romanian37
 
Latvian38
 
Croatian39
 
Thai40
 
Estonian41
 
Catalan42
 
Welsh43

 

Examples

This URL provides an example of the QuestionPoint KB API searching for all questions that match the search term “baseball”

http://questionpoint.org/crs/servlet/org.oclc.kb.KBSearchWS?&andk=baseball&preflang=3&kbids=1&kbids=13&type=xml

This URL provides an example of the QuestionPoint KB API searching for recent (within the last week) questions that match the search terms “Scotland” and “language”.

http://questionpoint.org/crs/servlet/org.oclc.kb.KBSearchWS?&sopt=kw&andk=scotland+language&dr=lw&preflang=4&kbids=1&type=xml

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