CiNii Books - メタデータ・API - CiNii Books 所蔵検索のOpenSearch

 

クエリ仕様

CiNii Books所蔵図書館検索のOpenSearchクエリは以下の形式です。
http://ci.nii.ac.jp/books/opensearch/holder?パラメータ=値)& (パラメータ=値)&…&(パラメータ=値)です。

クエリを構成する各パラメータは以下のとおりです。これ以外のパラメータの記述は無視します。

No. 項目名 パラメータ名 論理式の記述可否 備考
1 NCID ncid 不可 完全一致、必須です。
2 参加組織:ILL参加 ill 不可 A:参加、 N:不参加
3 参加組織:ILLステータス ill_stat 不可 A:可能、 N:不可能
4 参加組織:複写サービス ill_copys 不可 A:可能、C:他の窓口で受け付け、 N:不可能
5 参加組織:貸借サービス ill_loans 不可 A:可能、C: 他の窓口で受け付け、 N:不可能
6 参加組織:FAXサービス ill_faxs 不可 A:可能、C:条件つきで可能、 N:不可能
7 参加組織:日英ILL参加 ill_oclc 不可 A:参加、 N:不参加
8 参加組織:日韓ILL参加 ill_keris 不可 A:参加、 N:不参加
9 参加組織:料金相殺参加 ill_offset 不可 A:参加、 N:不参加
10 参加組織:参加組織番号 fano 不可 完全一致
11 雑誌所蔵:年 year 不可 範囲指定不可。 該当の書誌が図書の場合は無視します。
12 雑誌所蔵:巻 vol 不可 範囲指定不可。
13 雑誌所蔵:号 issue 不可 範囲指定不可。
14 雑誌所蔵:継続 cont 不可 0:非継続、1:継続
15 出力フォーマット format 不可 atom:ATOM形式(デフォルト)、rss: RSS形式、json: JSON-LD形式
16 アプリケーションID appid 不可 必須です。
  • 論理式の記述が可能な項目においては、大文字のAND,OR,NOT演算子及び括弧 (,) を使って条件を組み立てられます。
  • AND,OR,NOTとワードの間には空白が必要です。演算子を指定せずに列挙した場合はデフォルトの演算子(表中で括弧書きされた演算子)が使用されます。
 

レスポンス仕様

クエリでレスポンスのフォーマットを、RSS, Atom, JSON-LD, HTMLから選択できます。

 

RSS1.0 レスポンスフォーマット仕様

No. タグ名 必須 内容 備考
第1階層 第2階層 第3階層 第4階層 第5階層 属性
1 xml           必須 XML文書であることを宣言 <?xml version="1.0" encoding="utf-8" ?>
2 rdf:RDF           必須 文書のルート要素 xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。
  <rdf:RDF
xmlns xmlns="http://purl.org/rss/1.0/"
xmlns:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xxmlns:dc xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:opensearch xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
xml:lang xml:lang=”ja”>
3   channel       rdf:about 必須 リクエストされたURI この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&amp;」で連結する。パラメータからappidは取り除かれる
4     title       必須 タイトル 「CiNii Books Holder-」にクエリを連結したもの。
<title>CiNii Books Holder- ○○○○○</title>
5     description       必須 タイトル titleと同じ内容
6     link       必須 リクエストされたURI この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&amp;」で連結する。パラメータからappidは取り除かれる
7     dc:date       必須 検索が行われた日時 W3CDTF表記
8     opensearch:totalResults       必須 検索結果総数  
9     items       必須    
10       rdf:Seq     必須    
11         rdf:li rdf:resource 必須 図書館詳細ページのURI レスポンスに含まれる図書館詳細情報へのパーマリンクを列挙。最大でopensearch:itemsPerPageの数まで繰り返す
12   item       rdf:about 必須 図書館情報 最大でopensearch:itemsPerPageの数まで繰り返す。rdf:aboutにはパーマリンクを記述。
<item rdf:about="http://ci.nii.ac.jp/library/FA123456">
13     title       必須 図書館名  
14     link       必須 図書館詳細ページのURI 図書館詳細ページのパーマリンクを表示
<link>http://ci.nii.ac.jp/library/FA123456</link>
15     rdfs:seeAlso     rdf:resource 必須 図書館詳細情報RDFのURI 図書館詳細情報RDFのURIを表示(ただしappidのパラメータは除く)
<rdfs:seeAlso rdf:resource="http://ci.nii.ac.jp/library/FA123456.rdf" />
16     dc:date       必須 検索が行われた日時  
 

Atom1.0 レスポンスフォーマット仕様

No. タグ名 必須 内容 備考
第1階層 第2階層 第3階層 第4階層 属性
1 xml         必須 XML文書であることを宣言 <?xml version="1.0"encoding="UTF-8" ?>
2 feed         必須 文書のルート要素 xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。
  <feed
xmlns xmlns="http://www.w3.org/2005/Atom"
xmlns:opensearch xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
xml:lang xml:lang=”ja”>
3   title       必須 フィードのタイトル 「CiNii Books Holder-」にクエリを連結したもの。
<title>CiNii Books Holder- ○○○○○</title>
4   link     rel 必須 参照先の文書との関係 固定値(self)
5         type 必須 参照先の文書のMIMEタイプ 固定値(application/atom+xml)
6         href 必須 リクエストされたURI この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&amp;」で連結する。パラメータからappidは取り除かれる
7   id       必須 リクエストされたURI link要素と同じ
8   updated       必須 検索が行われた日時 W3CDTF表記
9   opensearch:totalResults       必須 検索結果総数  
10   entry         検索結果の図書館情報を格納するコンテナ 最大でopensearch:itemsPerPageの数まで繰り返す。
11     title     必須 図書館名  
12     link   href 必須 図書館詳細ページのURI 図書館詳細ページのパーマリンクを表示
<link href="http://ci.nii.ac.jp/library/FA123456"/>
13     link   rel 必須 参照先の文書との関係 固定値(alternate)
14         type 必須 参照先の文書のMIMEタイプ 固定値(application/rdf+xml)
15         href 必須 図書館詳細情報RDFのURI 図書館詳細情報RDFのURIを表示(ただしappidのパラメータは除く)
href="http://ci.nii.ac.jp/library/FA123456.rdf"
16     id     必須 図書館詳細ページのURI 図書館詳細ページのパーマリンクを表示
<id>http://ci.nii.ac.jp/library/FA123456</id>
17     updated     必須 検索が行われた日時  
 

JSON-LD レスポンスフォーマット仕様

No. タグ名 必須 内容 備考
第1階層 第2階層 第3階層 第4階層 第5階層
1 @context         オブジェクト 必須 文書のルート要素 "@context": {
"dc": "http://purl.org/dc/elements/1.1/",
"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
"opensearch": "http://a9.com/-/spec/opensearch/1.1/",
"rdfs": "http://www.w3.org/2000/01/rdf-schema#",
"@vocab": "http://purl.org/rss/1.0/"
},
2   @vocab         必須   http://purl.org/rss/1.0/
3   dc         必須   http://purl.org/dc/elements/1.1/
4   rdf         必須   http://www.w3.org/1999/02/22-rdf-syntax-ns#
5   opensearch         必須   http://a9.com/-/spec/opensearch/1.1/
6   rdfs         必須   http://www.w3.org/2000/01/rdf-schema#
7 @id           必須 リクエストされたURI この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる
8 @graph         配列 必須   配列の要素数は1
9   @id         必須 リクエストされたURI この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる
10   @type         必須   固定:"channel"
11   title         必須 タイトル 「CiNii Books Holder -」にクエリを連結したもの。
例:
"title":"CiNii Books Holder- ○○○○○",
12   description         必須 タイトル titleと同じ内容
13   link       オブジェクト 必須    
14     @id       必須 リクエストされたURI この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる
15   dc:date         必須 検索が行われた日時 W3CDTF表記
16   opensearch:totalResults         必須 検索結果総数  
17   items       配列      
18     @id       必須 図書館詳細ページのURI 図書館詳細ページのパーマリンクを表示
"@id":"http://ci.nii.ac.jp/library/FA123456",
19     @type       必須   固定:"item"
20     title       必須 図書館名  
21     link     オブジェクト 必須  
22       @id     必須 図書館詳細ページのURI 図書館詳細ページのURIのパーマリンクを表示
"link": {"@id":"http://ci.nii.ac.jp/library/FA123456"},
23     rdfs:seeAlso     オブジェクト 必須  
24       @id     必須 図書館詳細情報JSON-LDのURI 図書館詳細情報JSON-LDのURIを表示(ただしappidのパラメータは除く)
"rdfs:seeAlso":{"@id":"http://ci.nii.ac.jp/author/XX12345678.json"},
25     dc:date       必須 検索が行われた日時 W3CDTF表記
 

改訂履歴

2013年4月以降の改訂履歴をご確認いただけます。

2015年3月13日

JSON-LD レスポンスフォーマットを一部変更しました。詳細は以下のとおりです。

  • "items"タグをオブジェクトから配列に変更しました。
  • "rdf:Seq"と"rdf:li" タグを採用しない形式に変更しました。
  • JSON-LDによるCiNii ウェブAPIをベータ版としていましたが、上記の変更をもって正式版としました。

2013年10月11日

  • クエリ仕様の出力フォーマット(format)にJSON-LD形式(json)を追加しました。
  • レスポンスフォーマット仕様にJSON-LD(ベータ版)を追加しました。
  • クロスドメイン間の非同期通信に対応しました。