OpenSearch for Querying the Database

Last update 2012-04-20

Overview

We provide OpenSearch API for machine friendly search. OpenSearch API is compatible to OpenSearch API 1.1.As you can search researchers in the html page, you can also search researchers with a combination of some field parameters. Please read the following description of the query and response format.
Before use OpenSearch, please resist AIP Key on this page.
Currently, you can make free use of OpenSearch without API Key, but in the future, when the additional features like of access control for API Key and so on, contact you by registered mail address.

Query format in OpenSearch

Here is the template.

http://rns.nii.ac.jp/opensearch?q{field}={searchTerms}&start={startIndex?}&count={count?}&sort={sortOrder?}

*searchTerms must be URL-encoded in UTF-8.

q{field}={searchTerms} can be used multiple. but if input same field number of multiple, searchTerm of that field is used only first input. Use AND opereter.

Get a result set from the {startIndex}th item by {count} items. (default startIndex=1,count=10)


Field parameters. You have to set the field number to specicty search field.


q0
Search by all fields
q1
Search by researcher name
q2
Search by institution
q3
Search by department
q4
Search by job title
q5
Search by KAKENHI Researcher Number
q6
Search by Researcher Name Resolver ID
q7
Search by research keywords of KAKENHI research projects
q8
Search by research fields KAKENHI research projects

The search method of fields parameters


Common to all fields
You can use logic operations, such as【AND】,【OR】,【NOT】(These letters are upper-cased) and parenthesis【()】.
Space between keywords means the same as 【OR】opereter.
kanji variants are the same search results.(e.g.【渡辺】and【渡邊】and【渡邉】are the same results)
Prefix match or Suffix match by using wildcard【*】.
If searching by wildcard only, all resrchers appear in results.
Phrase search by putting double quotes【"】around a set of words.
if you search by more than one field, it is 【AND】search.
q0
The search method of each field is the same as that of single field.
q1
Searching exact eatch for first-name only or family-name only or fullname without space(family-name+first-name) by default
q5,6
Searching Three or more digit number by default
Exact Match by putting slash【/】around a set of numbers.
etc.
Searching a letter(in Japanese) or a word(in English) by default
Exact Match by putting double quotes【"】around a set of words.(without space)

Abont sort order


parameter(sortOrder)
sort order
0
Kana order asc of Researcher Name
1
Kana order desc of Researcher Name
2
Alphabetic order asc of Researcher Name
3
Alphabetic order desc of Researcher Name
4
Kanji code order asc of Researcher Name
5
Kanji code order desc of Researcher Name
6
Score order
Unspecified
Kana order asc of Researcher Name

Examples


Example 1)

If you want to search a researcher name "Takeda" and get a result set from the 1st item by 20 items, the url is;

http://rns.nii.ac.jp/opensearch?q1=Takeda&start=1&count=20

Example 2)

If you want to search a researcher name "武田" and get a result set from the 1st item by 20 items, the url is;

http://rns.nii.ac.jp/opensearch?q0=%E6%AD%A6%E7%94%B0&start=1&count=20

Example 3)

If you want to search a researcher name "Takeda" and sort order is "Alphabetic order asc" and get a result set from the 1st item by 20 items, the url is;

http://rns.nii.ac.jp/opensearch?q1=Takeda&start=1&count=20

Response format of result set

When you send a query in the OpenSearch format, for instance,

http://rns.nii.ac.jp/opensearch?q0=%E6%AD%A6%E7%94%B0&start=1&count=3

you can get response in XML format which is RSS1.0 as follows:



The tags used in the XML response format is as follows.
channel
Channel description in RSS1.0.
rdf:about URI of this channel type resource
title
A descriptive title for the channel. "Researcher Name Resolver OpenSearch"
link
URL of this service
items
Search result list of items
rdf:seq
List in sequence
rdf:li
Items in list
atom:link atom:rel="self"
The current page URL of result set
atom:link atom:rel="first"
The first page URL of result set
atom:link atom:rel="next"
The next page URL of result set
atom:link atom:rel="last"
The last page URL of result set
item
Item description
rdf:about
URI of this item type resource
title
Descriptive tilte of this item. "Researcher Name Resolver - $researcherName (Researcher Name Resolver ID)"
link
Link to Researcher URI. This is the same as URI of this resource.
content:encoded
HTML encoded description of this item. This may be shown in RSS reader.


You should see the next help document to access the researcher URIs.