トップページ > OpenSearch

OpenSearch

Table of Contents


1. アクセスURL

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

2.リクエストURL

リクエストURLは、アクセスURLに以下の様に検索条件を付加した形式となります。
http://kn.ndl.go.jp/api/opensearch? [引数]=[値]
引数を複数使用する場合は&で連結します。
http://kn.ndl.go.jp/api/opensearch? [引数1]=[値]&[引数2]=[値]&...

3.引数

引数名 内容 一致条件 複数(同一引数内) 複数(同一リクエスト内)
anyひなぎくの詳細検索画面のキーワード検索に相当部分一致-
titleタイトル部分一致-
creator作成者部分一致-
publisher出版者・公開者部分一致-
from日付で絞込み検索を行う際の開始日付
(YYYY-MM-DD)
 ×-
cnt出力レコード上限値
(省略時は200とする)
 ×-
idxレコード取得開始位置
(省略時は1とする)
 ×-
identifier識別子。震災IDを指定。
震災IDは、詳細画面のURL:http://kn.ndl.gojp/xxxxのxxxxの部分。
  
mediatype資料種別。値により資料種別を指定。
指定できる値は、1・・・文書資料, 2・・・Webサイト, 3・・・写真, 4・・・音声・動画, 99・・・その他
 -
dpid検索対象データベース。リポジトリIDを指定。 -
language言語。ISO639-2形式で指定 -
openAccess"1"を指定した場合、「Web閲覧可」のデータのみ対象 ×-
(備考)
・引数間の論理条件はすべてANDである。
・引数の値は、"(半角ダブルクォーテーション)で囲む必要はない。
但し、複数値を指定する場合は、"で値を囲み、値は、△(半角スペース)区切りで区切る。
(例)title="津波 地震"
・引数内に複数値を指定した場合は、値間の論理条件は全てANDである。
・URLエンコードは、値ごとに行う。上記の例だと、title="津波 地震"ではなく"津波 地震"に対して行う。
・引数の値が不適切な場合には検索結果0件となる。

4.データ返却形式

4.1.基本構造

返戻されるデータは、下表のとおり

・ひなぎくで提供しているOpnesearchの情報
・itemタグで繰り返す、個々の資料のメタデータ

からなります。

タグ名 内容
titleサービス名が返却されます。NDL東日本大震災アーカイブ OpenSearch
linkRSS 発行元URLが返却されます。http://kn.ndl.go.jp
description検索条件が返却されます。形式は以下のとおりです。
Search result for [引数]=[値]
引数が複数存在する場合は、半角スペースで区切られて表示されます。
例:
Search result for title= 防災
Search result for title= 防災 any=津波
language使用している言語が返却されます。
言語はISO639-2形式で返却されます。
ja
openSearch:totalResults取得リストのデータ数(検索結果件数)が返却されます。-
openSearch:startIndex引数「idx」で指定したidxの値(レコード取得開始位置)が返却されます。指定を省略した場合、一律「1」が返却されます。-
item個々の資料に対するメタデータが返却されます。複数のメタデータが返却される場合、資料の数だけitemタグが繰り返されます。-

4.2.itemタグの内訳

個々の資料のメタデータは
  • RSS2.0 準拠項目・・・タグの属性値が"xmlns:xsi="で始まるもの。
  • dc項目・・・タグの属性値が"xmlns:dc="で始まるもの。
からなります。
RSS2.0 準拠項目は、以下のとおりです。

タグ名 内容
title資料のタイトル-
link資料の詳細情報画面のURL。形式は以下の通り。
http://kn.ndl.go.jp/震災ID]
例:http://kn.ndl.go.jp/R200200041-I000000398-00
descriptionメタデータの概要。形式は以下のとおりです。
<![CDATA[(メタデータの概要がここに記載)]]>
guid震災ID例:R200200041-I000000398-00
pubDates出版年月日。yyyy-mm-dd形式。例:2017-03-17
category資料種別
mediatypeの値に対応する日本語名。
例:文書資料

5.リクエスト例

タイトルに「防災」の用語を含む資料を検索する場合
リクエスト形式は、以下のとおりとなります。

http://kn.ndl.go.jp/api/opensearch?title=防災

このままでは検索出来ないので、「防災」の文字列をURLエンコードする必要があります。
「防災」のURLエンコード値は、「%E9%98%B2%E7%81%BD」なので、実際のリクエストに用いるURLは以下のとおりとなります。
http://kn.ndl.go.jp/api/opensearch?title=%E9%98%B2%E7%81%BD

国立国会図書館東日本大震災アーカイブについて

最新のお知らせ



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