クエリ仕様
CiNii Researchの図書館検索のOpenSearchクエリは以下の形式です。
https://cir.nii.ac.jp/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以外の属性は以下の文字列を記述する。 | |||||
| 3 | <rdf:RDF | ||||||||
| 4 | xmlns | xmlns="http://purl.org/rss/1.0/" | |||||||
| 5 | xmlns:rdf | xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" | |||||||
| 6 | xmlns:rdfs | xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" | |||||||
| 7 | xmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | |||||||
| 8 | xmlns:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | |||||||
| 9 | xmlns:cir | xmlns:cir="https://cir.nii.ac.jp/schema/1.0/" | |||||||
| 10 | xml:lang | xml:lang="ja"> | |||||||
| 11 | channel | rdf:about | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | ||||
| 12 | title | 必須 | タイトル | 「CiNii Research Library -」にクエリを連結したもの。 例: <title>CiNii Research Library - FA001062</title> |
|||||
| 13 | description | 必須 | タイトル | titleと同じ内容 | |||||
| 14 | link | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | |||||
| 15 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
| 16 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
| 17 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | |||||
| 18 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | |||||
| 19 | items | 必須 | |||||||
| 20 | rdf:Seq | 必須 | |||||||
| 21 | rdf:li | rdf:resource | 必須 | 図書館詳細ページのURI | レスポンスに含まれる図書館詳細情報へのパーマリンクを列挙。最大でopensearch:itemsPerPageの数まで繰り返す | ||||
| 22 | item | rdf:about | 必須 | 図書館情報 | 最大でopensearch:itemsPerPageの数まで繰り返す。rdf:aboutにはパーマリンクを記述。 <item rdf:about="https://ci.nii.ac.jp/library/FA123456"> |
||||
| 23 | title | 必須 | 図書館名 | ||||||
| 24 | link | 必須 | 図書館詳細ページのURI | 図書館詳細ページのパーマリンクを表示 <link>https://ci.nii.ac.jp/library/FA123456</link> | |||||
| 25 | rdfs:seeAlso | rdf:resource | 必須 | 図書館詳細情報RDFのURI | 図書館詳細情報RDFのURIを表示 <rdfs:seeAlso rdf:resource="https://ci.nii.ac.jp/library/FA123456.rdf" /> |
||||
| 26 | dc:identifier | 必須 | 識別子 | ||||||
| 27 | rdf:datatype | 必須 | 識別子のタイプ | "cir:FANO" | |||||
| 28 | (値) | 必須 | 識別子の値 | 図書館IDを出力する | |||||
| 29 | dc:date | 必須 | 検索が行われた日時 |
Atom1.0 レスポンスフォーマット仕様
| No. | タグ名 | 必須 | 内容 | 備考 | |||||
|---|---|---|---|---|---|---|---|---|---|
| 第1階層 | 第2階層 | 第3階層 | 第4階層 | 第5階層 | 属性 | ||||
| 1 | xml | 必須 | XML文書であることを宣言 | <?xml version="1.0" encoding="utf-8" ?> | |||||
| 2 | feed | 必須 | 文書のルート要素 | xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。 | |||||
| 3 | <feed | ||||||||
| 4 | xmlns | xmlns="http://www.w3.org/2005/Atom" | |||||||
| 5 | xmlns:rdf | xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" | |||||||
| 6 | xmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | |||||||
| 7 | xmlns:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | |||||||
| 8 | xmlns:cir | xmlns:cir="https://cir.nii.ac.jp/schema/1.0/" | |||||||
| 9 | xml:lang | xml:lang="ja"> | |||||||
| 10 | title | 必須 | フィードのタイトル | 「CiNii Research Library -」にクエリを連結したもの。 例: <title>CiNii Research Library - FA001062</title> |
|||||
| 11 | link | rel | 必須 | 参照先の文書との関係 | 固定値(self) | ||||
| 12 | type | 必須 | 参照先の文書のMIMEタイプ | 固定値(application/atom+xml) | |||||
| 13 | href | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。パラメータからappidは取り除かれる | |||||
| 14 | id | 必須 | リクエストされたURI | link要素と同じ | |||||
| 15 | updated | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
| 16 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
| 17 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | |||||
| 18 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | |||||
| 19 | entry | 検索結果の図書館情報を格納するコンテナ | 最大でopensearch:itemsPerPageの数まで繰り返す。 | ||||||
| 20 | title | 必須 | 図書館名 | ||||||
| 21 | link | href | 必須 | 図書館詳細ページのURI | 図書館詳細ページのパーマリンクを表示 <link href="https://ci.nii.ac.jp/library/FA123456"/> |
||||
| 22 | link | rel | 必須 | 参照先の文書との関係 | 固定値(alternate) | ||||
| 23 | type | 必須 | 参照先の文書のMIMEタイプ | 固定値(application/rdf+xml) | |||||
| 24 | href | 必須 | 図書館詳細情報RDFのURI | 図書館詳細情報RDFのURIを表示 href="https://ci.nii.ac.jp/library/FA123456.rdf" |
|||||
| 25 | id | 必須 | 図書館詳細ページのURI | 図書館詳細ページのパーマリンクを表示 <id>https://ci.nii.ac.jp/library/FA123456</id> |
|||||
| 26 | dc:identifier | 必須 | 識別子 | ||||||
| 27 | rdf:datatype | 必須 | 識別子のタイプ | "cir:FANO" | |||||
| 28 | (値) | 必須 | 識別子の値 | 図書館IDを出力する | |||||
| 29 | 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/", "cir":"https://cir.nii.ac.jp/schema/1.0/" "rdfs": "http://www.w3.org/2000/01/rdf-schema#", "@vocab": "http://purl.org/rss/1.0/" }, |
||||
| 2 | dc | 必須 | http://purl.org/dc/elements/1.1/ | ||||||
| 3 | rdf | 必須 | http://www.w3.org/1999/02/22-rdf-syntax-ns# | ||||||
| 4 | opensearch | 必須 | http://a9.com/-/spec/opensearch/1.1/ | ||||||
| 5 | cir | 必須 | https://cir.nii.ac.jp/schema/1.0/ | ||||||
| 6 | rdfs | 必須 | http://www.w3.org/2000/01/rdf-schema# | ||||||
| 7 | @vocab | 必須 | http://purl.org/rss/1.0/ | ||||||
| 8 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 9 | @graph | 配列 | 必須 | 配列の要素数は1 | |||||
| 10 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 11 | @type | 必須 | 固定:"channel" | ||||||
| 12 | title | 必須 | タイトル | 「CiNii Research Library -」にクエリを連結したもの。 例: "title":"CiNii Research Library - FA123456", |
|||||
| 13 | description | 必須 | タイトル | titleと同じ内容 | |||||
| 14 | link | オブジェクト | 必須 | ||||||
| 15 | @id | 必須 | リクエストされたURI | この検索リクエストのURI。クエリをURLエンコードし、「変数名=値」形式で出力。パラメータからappidは取り除かれる | |||||
| 16 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 | |||||
| 17 | opensearch:totalResults | 必須 | 検索結果総数 | ||||||
| 18 | opensearch:startIndex | 必須 | 開始番号 | 検索結果のうち、何件目のデータから記述しているかを表示する | |||||
| 19 | opensearch:itemsPerPage | 必須 | 件数 | レスポンスに何件の検索結果が含まれているかを表示する | |||||
| 20 | items | 配列 | |||||||
| 21 | @id | 必須 | 図書館詳細ページのURI | 図書館詳細ページのパーマリンクを表示 "@id":"https://ci.nii.ac.jp/library/FA123456", |
|||||
| 22 | @type | 必須 | 固定:"item" | ||||||
| 23 | title | 必須 | 図書館名 | ||||||
| 24 | link | オブジェクト | 必須 | ||||||
| 25 | @id | 必須 | 図書館詳細ページのURI | 図書館詳細ページのURIのパーマリンクを表示 "link": {"@id":"https://ci.nii.ac.jp/library/FA123456"}, |
|||||
| 26 | rdfs:seeAlso | オブジェクト | 必須 | ||||||
| 27 | @id | 必須 | 図書館詳細情報JSON-LDのURI | 図書館詳細情報JSON-LDのURIを表示 "rdfs:seeAlso":{"@id":"https://ci.nii.ac.jp/library/FA123456.json"}, |
|||||
| 28 | dc:identifier | 必須 | 識別子 | ||||||
| 29 | @type | 必須 | 識別子のタイプ | "cir:FANO" | |||||
| 30 | @value | 必須 | 識別子の値 | 図書館IDを出力する | |||||
| 31 | dc:date | 必須 | 検索が行われた日時 | W3CDTF表記 |