Top page > OpenSearch

OpenSearch

Table of Contents



1. URL

http://kn.ndl.go.jp/api/opensearch

2. The request form

http://kn.ndl.go.jp/api/opensearch? [Referring a name] = [the price]
A reference name, more than one, when using, I connect by&.
http://kn.ndl.go.jp/api/opensearch? [Reference great 1] = [the price] and [reference great 2]= [the price]&.

3. A reference example

Referring a nameThe contentsThe parallel condition
anyIt's suitable for a key word search of a in-depth retrieval screen of a daisy.Partial agreement
titleThe titlePartial agreement
creatorMakerPartial agreement
publisherPublication person and opening to the public personPartial agreement
fromThe starting date when doing a narrow search by a date
(YYYY - MM - DD)
 
cntThe output record upper limit value
(When omitting, it's made 200.)
 
idxRecord acquisition start position
(When omitting, it's made 1.)
 
identifierIdentifier. A ISS token is designated.
A ISS token is a part in xxxx in URL:http://kn.ndl.gojp/xxxx of a in-depth screen.
 
mediatypeMaterial designation. Material designation is designated by the price.
The price which can be designated, 1 Documentary material and  2 Web site and 3 Picture and 4 Sound and animation , 99 Others.
 
dpidSearch target data base. The repository ID is designated. 
languageLanguage. It's designated by ISO639-2 form. 
openAccess" When designating it, "it's possible" to do web reading of 1", only data is a target. 

(Note)
* The logic condition during a reference name is everything and DEARU.
* The price of the reference name,", it isn't necessary to surround with (one-byte double quotation).
* Uniform Resource Locator encoding is performed every price.
* When the price of the reference name is improper, it'll be 0 search results.
* More than one, (in identical reference name), more than one, (in identical request), for, it doesn't correspond.

4. The data return form

4.1. Basic structure

As returned data is the following table.

* Information on Opensearch offered by a daisy
* Metadata of each material repeated by a item tag

Vanity will be.

Tag nameThe contentsThe price
titleA service name is returned.NDL eastern Japan great earthquake archive OpenSearch.
linkRSS Publisher Uniform Resource Locator is returned.http://kn.ndl.go.jp
descriptionSearch condition is returned. The form is as follows.
Search result for [referring a name] = [the price]
A reference name, more than one, when existing, it's divided by one-byte space and shown.
An example:
Search result for title= Protection against disasters.
Search result for title= Disaster prevention any= tidal wave.
languageThe language which is being used is returned.
A language is returned by ISO639-2 form.
ja
openSearch:totalResultsThe number of data of the acquisition list (the search result number) is returned.-
openSearch:startIndexThe price of idx designated by a reference name "idx" (record acquisition start position) is returned. When omitting designation, "1" is returned uniformly.-
itemMetadata to each material is returned. When more than one metadata is returned, a item tag is repeated by only the number of the material.-

The details of the 4.2.item tag

Metadata of each material?

* RSS2.0 The item based Something by which property value of a tag starts with "xmlns:xsi=".
* The dc item Something by which property value of a tag starts with "xmlns:dc=".

Vanity will be.

RSS2.0 The item based is as follows.

Tag nameThe contentsThe price
titleThe title of the material-
linkUniform Resource Locator of a detailed information screen of material. The form is as follows.
http://kn.ndl.go.jp/ISS token]
Example :http://kn.ndl.go.jp/R200200041-I000000398-00
descriptionThe outline of metadata. The form is as follows.
<! [CDATA [ (The outline of metadata mentions here.)]]>
guidISS tokenExample :R200200041-I000000398-00
pubDatesPublication date. The yyyy-mm-dd form.An example: 2017-03-17
categoryMaterial designation
Japanese name which corresponds to the price of mediatype.
An example: Documentary material

5. A request example

When I search for material including terminology of "disaster prevention" in the title.
The request form becomes as follows.

http://kn.ndl.go.jp/api/opensearch? title= protection against disasters

Then you can't search, so it's necessary to do Uniform Resource Locator encoding of a character string of "disaster prevention" just as it is.
The Uniform Resource Locator encoding value of "disaster prevention" is "%E9%98%B2%E7%81%BD", so Uniform Resource Locator used for an actual request becomes as follows.
http://kn.ndl.go.jp/api/opensearch? title=%E9%98%B2%E7%81%BD

About National Diet Library eastern Japan great earthquake archive.

The latest news



Copyright © 2013- National Diet Library. All Rights Reserved.