クエリ仕様
CiNii Books図書館検索のOpenSearchクエリは以下の形式です。
https://ci.nii.ac.jp/books/opensearch/library?(パラメータ=値)& (パラメータ=値)&…&(パラメータ=値)です。
クエリを構成する各パラメータは以下のとおりです。これ以外のパラメータの記述は無視します。
| No. | 項目名 | パラメータ名 | 論理式の記述可否 | 備考 | |
|---|---|---|---|---|---|
| 1 | 図書館名 | name | 可（AND) | 部分一致テキスト検索、または図書館ID（参加組織番号）の完全一致。必須です。 | |
| 2 | 出力フォーマット | format | 不可 | atom:ATOM形式（デフォルト）、rss: RSS形式、json: JSON-LD形式 | |
| 3 | ソート順 | sortorder | 不可 | 1:検索スコア順（デフォルト）、2:図書館ID昇順、3:図書館ID降順、4:県コード昇順、5:県コード降順、6:図書館名五十音順、7:参加組織名五十音逆順 | |
| 4 | ページ番号 | p | 不可 | 最初のページを1とします。 | |
| 5 | 1ページあたりの結果数 | count | 不可 | デフォルト20 | |
| 6 | アプリケーションID | appid | 不可 | 必須です。 | |
- 論理式の記述が可能な項目においては、大文字のAND,OR,NOT演算子及び括弧 (,) を使って条件を組み立てられます。
- AND,OR,NOTとワードの間には空白が必要です。演算子を指定せずに列挙した場合はデフォルトの演算子（表中で括弧書きされた演算子）が使用されます。
レスポンス仕様
クエリでレスポンスのフォーマットを、RSS, Atom, JSON-LDから選択できます。
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#" | ||||||||
| xmlns: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エンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | ||||
| 4 | title | 必須 | タイトル | 「CiNii Books Organization-」にクエリを連結したもの。 例： <title>CiNii Books Organization- 大阪教育大学</title> |
|||||
| 5 | description | 必須 | タイトル | titleと同じ内容 | |||||
| 6 | link | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | |||||
| 7 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
| 8 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
| 9 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | |||||
| 10 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | |||||
| 11 | items | 必須 | |||||||
| 12 | rdf:Seq | 必須 | |||||||
| 13 | rdf:li | rdf:resource | 必須 | 図書館詳細ページのURI | レスポンスに含まれる図書館詳細情報へのパーマリンクを列挙。最大でopensearch:itemsPerPageの数まで繰り返す | ||||
| 14 | item | rdf:about | 必須 | 図書館情報 | 最大でopensearch:itemsPerPageの数まで繰り返す。rdf:aboutにはパーマリンクを記述。 <item rdf:about="http://ci.nii.ac.jp/library/FA123456"> |
||||
| 15 | title | 必須 | 図書館名 | ||||||
| 16 | link | 必須 | 図書館詳細ページのURI | 図書館詳細ページのパーマリンクを表示<link>http://ci.nii.ac.jp/library/FA123456</link> | |||||
| 17 | rdfs:seeAlso | rdf:resource | 必須 | 図書館詳細情報RDFのURI | 図書館詳細情報RDFのURIを表示(ただしappidのパラメータは除く)<rdfs:seeAlso rdf:resource="http://ci.nii.ac.jp/library/FA123456.rdf" /> | ||||
| 18 | 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 Organization OpenSearch - 」 に検索語を連結したもの。 例： <title>CiNii Organization OpenSearch - 大阪教育大学</title> |
||||
| 4 | link | rel | 必須 | 参照先の文書との関係 | 固定値(self) | |||
| 5 | type | 必須 | 参照先の文書のMIMEタイプ | 固定値（application/atom+xml） | ||||
| 6 | href | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | ||||
| 7 | id | 必須 | リクエストされたURI | link要素と同じ | ||||
| 8 | updated | 必須 | 検索が行われた日時 | W3CDTF表記 | ||||
| 9 | opensearch:totalResults | 必須 | 検索結果総数 | |||||
| 10 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | ||||
| 11 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | ||||
| 12 | entry | 検索結果の図書館情報を格納するコンテナ | 最大でopensearch:itemsPerPageの数まで繰り返す。 | |||||
| 13 | title | 必須 | 図書館名 | |||||
| 14 | link | href | 必須 | 図書館詳細ページのURI | 図書館詳細ページのパーマリンクを表示 <link href="http://ci.nii.ac.jp/library/FA123456"/> |
|||
| 15 | link | rel | 必須 | 参照先の文書との関係 | 固定値(alternate) | |||
| 16 | type | 必須 | 参照先の文書のMIMEタイプ | 固定値（application/rdf+xml） | ||||
| 17 | href | 必須 | 図書館詳細情報RDFのURI | 図書館詳細情報RDFのURIを表示(ただしappidのパラメータは除く） href="http://ci.nii.ac.jp/library/FA123456.rdf" |
||||
| 18 | id | 必須 | 図書館詳細ページのURI | 図書館詳細ページのパーマリンクを表示 <id>http://ci.nii.ac.jp/library/FA123456</id> |
||||
| 19 | 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 Organization -」にクエリを連結したもの。 例： "title":"CiNii Books Organization - 大阪教育大学", |
|||||
| 12 | description | 必須 | タイトル | titleと同じ内容 | |||||
| 13 | link | オブジェクト | 必須 | ||||||
| 14 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 15 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
| 16 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
| 17 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | |||||
| 18 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | |||||
| 19 | items | 配列 | |||||||
| 20 | @id | 必須 | 図書館詳細ページのURI | 図書館詳細ページのパーマリンクを表示 "@id":"http://ci.nii.ac.jp/library/FA123456", |
|||||
| 21 | @type | 必須 | 固定:"item" | ||||||
| 22 | title | 必須 | 図書館名 | ||||||
| 23 | link | オブジェクト | 必須 | ||||||
| 24 | @id | 必須 | 図書館詳細ページのURI | 図書館詳細ページのURIのパーマリンクを表示 "link": {"@id":"http://ci.nii.ac.jp/library/FA123456"}, |
|||||
| 25 | rdfs:seeAlso | オブジェクト | 必須 | ||||||
| 26 | @id | 必須 | 図書館詳細情報JSON-LDのURI | 図書館詳細情報JSON-LDのURIを表示(ただしappidのパラメータは除く） "rdfs:seeAlso":{"@id":"http://ci.nii.ac.jp/author/XX12345678.json"}, |
|||||
| 27 | 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（ベータ版）を追加しました。
- クロスドメイン間の非同期通信に対応しました。