トップページ > OAI-PMH

OAI-PMH

Table of Contents


1.アクセスURL

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

2.リクエストURL

リクエストURLは、アクセスURLにリクエスト種別を指定した形式となります。 http://kn.ndl.go.jp/api/oaipmh?verb=[リクエスト種別]
1つのリクエストURLで設定できるリクエスト種別は1つだけです。

リクエスト種別によっては、メタデータの選択条件を引数により指定できます。
引数は、[引数]=[値]で指定し、以下の形式となります。
http://kn.ndl.go.jp/api/oaipmh?verb=[リクエスト種別]=[引数]=[値]

引数を複数使用する場合は、[引数]=[値]を&で連結します。
http://kn.ndl.go.jp/api/oaipmh?verb=[リクエスト種別]=[引数1]=[値]&[引数2]=[値]&...

3.リクエスト種別とメタデータの選択条件

3.1.リクエスト種別

リクエスト種別名 内容 引数指定
GetRecord特定のメタデータを1件取得する必須
identifyひなぎくが提供するOAI-PMHについての情報を取得する-
ListIdentifiersひなぎくから取得できるメタデータの震災IDを取得する必須
ListMetadataFormatsひなぎくが対応しているメタデータの形式を取得する任意
ListRecordsひなぎくから取得できるメタデータを取得する必須
ListSetsひなぎくが対応しているset(絞込み条件)を取得する任意

3.2.リクエスト種別と対応引数

リクエスト種別名 引数
identifier metadataPrefix from until set resumptionToken
GetRecord----
identify------
ListIdentifiers-
ListMetadataFormats-----
ListRecords-
ListSets-----
◎:必須、○:任意、- : 対象外
fromとuntilで指定する期間は最大で1年間

3.3.メタデータの選択条件

下表の引数により、メタデータの選択条件が指定できます。
引数名 内容
identifier震災IDを指定。
identifier=oai:kn.ndl.go.jp:[震災ID]の形式で指定する。
震災IDは、詳細画面のURL:http://kn.ndl.gojp/#/part/xxxxのxxxxの部分。
identifier=oai:kn.ndl.go.jp:R200200041-I000000226-00
metadataPrefixメタデータの返戻形式を指定する。
oai_dc・・・Dublin Coreの基本15要素であるDublin Core Metadata Element Setを出力する際の形式
ndlkn・・・国立国会図書館東日本大震災メタデータスキーマ形式
metadataPrefix=ndlkn
from日付(datestamp)の下限を指定する。
YYYY, YYYY-MM, YYYY-MM-DD形式で指定する。
from=2016-10-01
until日付(datestamp)の上限を指定する。
YYYY, YYYY-MM, YYYY-MM-DD形式で指定する。
※untilを指定しない場合、返戻期間はfromから365日。
until=2016-10-01
setリポジトリID又は資料種別名を指定
・リポジトリID
リポジトリIDは1つしか指定できません。
set=[リポジトリID]

・資料種別
set=[資料種別名] 以下の日本語に対応した資料種別名で指定します。
文書資料・・・documents, Webサイト・・・website, 写真・・・picture, 音声・動画・・・audio-video, その他・・・other

・リポジトリIDと資料種別を指定
区切り文字として「:」(半角コロン)を使用し以下の様に指定する。
set=[リポジトリID]:[資料種別名]
set=200041
set=audio-video
set=200041:audio-video
resumptionToken1リクエストの返戻メタデータ件数が取得上限数である200件を超えた場合、201件目以降のメタデータを取得するために指定。メタデータを全て取得するには、200件ごとにresumptionTokenを指定する必要がある。
指定するresumptionTokenの引数値は、200件ごとのメタデータの最後に表示されるresumptionTokenタグの値である。

※resumptionTokenタグの説明
1リクエストで200件以上メタデータが返戻された場合、以下の様にresumptionTokenタグの行が返戻される。

<resumptionToken cursor="0" completeListSize="△△△">○○○</resumptionToken>

・タグ値・・・○○○
・"cursor"・・・前回のリクエストで取得したメタデータの件数。初回リクエストの場合、"0"、2回目の場合、"200"、3回目の場合、"400"となる。
上記の例は、初回リクエスト時の返戻なのでcursor="0"となっている。
・"completeListSize"・・・メタデータの総件数。上記の例では、△△△。

201件目から400件目までのメタデータ取得する場合、resumptionToken=○○○と指定する。
201件目から400件目のメタデータを取得する際に、

・401件目以降のメタデータが存在・・・resumptionTokenタグが表示されるので、401件目以降のメタデータを取得したい場合には、新たに表示されたresumptionTokenタグの値を使用する。
・メタデータの件数が400件以下・・・リクエストに対するメタデータが全件取得できたことを示す以下のタグが表示される。
<resumptionToken completeListSize="○○○"/>
resumptionToken=ndlkn/2016-09-01/2017-07-07T01:08:39Z/200041/400/1498470365577

4.設定情報

Identifyリクエストにより、ひなぎくで提供しているOAI-PMHについての情報が、<Identify>タグの値として取得できます。
<Identify>タグ内のタグとその内容は以下の通り

タグ名 内容 応答値
repositoryNameOAI-PMHを提供しているサービス名NDL The Great East Japan Earthquake Archive
baseURL提供するOAI-PMHのベースURLhttp://kn.ndl.go.jp/api/oaipmh
protocolVersion提供するOAI-PMHのバージョンVersion 2.0
adminEmail管理者のメールアドレスhinagiku@ndl.go.jp
earliestDatestampシステム初期構築日ないし全面再構築日-
deletedRecord削除済みレコードに対する処理法。
・no: 削除についての情報を保持しません。
・persistent: 削除についての情報を永続的に保持します。削除履歴をすべて永続的に保持し、削除済みレコードのステータスを常に表示します。
・transient:削除についての情報を制限付で保持(一定日付以降のものに関して保持)。
persistent
Granularityシステムが対応している日付精度YYYY-MM-DDThh:mm:ssZ
repositoryIdentifierサービスを一意に同定する名前kn.ndl.go.jp

5.リクエスト例

例1. Identify リクエスト
http://kn.ndl.go.jp/api/oaipmh?verb=Identify
例2. ListMetadataFormats リクエスト
http://kn.ndl.go.jp/api/oaipmh?verb=ListMetadataFormats
例3. ListIdentifiers リクエスト
http://kn.ndl.go.jp/api/oaipmh?verb=ListIdentifiers&metadataPrefix=oai_dc&from=2016-10-01
例4. ListRecords リクエスト
http://kn.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=oai_dc&from=2016-10-01
例5. ListSets リクエスト
http://kn.ndl.go.jp/api/oaipmh?verb=ListSets
例6. GetRecord リクエスト
http://kn.ndl.go.jp/api/oaipmh?verb=GetRecord&metadataPrefix=oai_dc&identifier=oai:kn.ndl.go.jp:R200200041-I000000065-00

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

最新のお知らせ



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