現在位置

レファレンス協同データベースシステム　検索用API 2.0 仕様書

リクエストパラメータ

リクエストパラメータ
項目 必須区分 パラメータ 値 内容 備考
検索区分 任意 type 検索対象を設定
reference ： レファレンス事例
manual ： 調べ方マニュアル
collection ： 特別コレクション
profile ： 参加館プロファイル
all ： すべてを対象		 指定がない場合はデフォルト値「all」を補完する。
※allの場合、queryはanywhereのみ使用可能。
検索条件 いずれか必須 query string
（UTF-8でURLエンコード）		 CQL方式で各項目に対する検索クエリーを作成する。（検索条件の作成に関してはCQLフォーマット参照）
事例作成日FROM crt-date_from YYYYMMDD
事例作成日TO crt-date_to YYYYMMDD
登録日FROM reg-date_from YYYYMMDD
登録日TO reg-date_to YYYYMMDD
最終更新日FROM lst-date_from YYYYMMDD
最終更新日TO lst-date_to YYYYMMDD
提供館コード 任意 lib-id 完全一致で検索する。提供館名で検索を行いたい場合、queryにて指定を行う。
参加館プロファイルの図書館コードも対象とする。
検索対象 任意 lib-group string all ： 全館
ndl ： 国立国会図書館
public ： 公共図書館
academic ： 大学図書館
special ： 専門図書館
school ： 学校図書館
archives ： アーカイブズ		 指定がない場合はデフォルト値「all」を補完する。
検索結果取得フォーマット 任意 results_format string xml
rss		 指定がない場合はデフォルト値「xml」を補完する。
検索結果取得位置 任意 results_get_position int 指定がない場合はデフォルト値「1」を補完する。
検索結果返却件数 任意 results_num int 指定がない場合はデフォルト値「200」を補完する。
ソート項目 任意 sort string
（UTF-8でURLエンコード）		 ＜レファレンス事例＞
fit：適合度
reg-id：管理番号
crt-date：事例作成日
reg-date：登録日時
lst-date：最終更新日時
access-num：アクセス数
applause-num：拍手数

＜調べ方マニュアル＞
fit：適合度
reg-id：管理番号
crt-date：調べ方作成日
reg-date：登録日時
lst-date：最終更新日時
access-num：アクセス数
applause-num：拍手数

＜特別コレクション＞
fit：適合度
reg-id：管理番号
reg-date：登録日時
lst-date：最終更新日時
access-num：アクセス数
applause-num：拍手数

＜参加館プロファイル＞
fit：適合度
pro-key：図書館ヨミ
reg-date：登録日時
lst-date：最終更新日時
access-num：アクセス数
applause-num：拍手数		 指定がない場合はfitを補完する。
＊すべて第2ソートキーは最終更新日、第3ソートキーは登録番号となる。
ソート条件 任意 sort_order string asc：昇順
desc：降順		 指定がない場合はデフォルト値「desc」を補完する。（fitのdescは適合度が高い順となる。）

CQLフォーマット

CQL（Contextual Query Language）で使われる語句のうち使用できるものは、下記に記載のあるものです。下記に記載のない語句（sortBy等）はご利用になれません。

  • クエリー対象項目（レファレンス事例）
    項目表示名 項目名 備考
    全項目（簡易検索） anywhere 簡易検索と同範囲での検索となる。
    質問 question
    管理番号 reg-id 前方一致
    回答 answer
    解決／未解決 solution 完全一致
    0 ： 解決
    1 ： 未解決
    ※以下についても許可する
    resolved ： 解決
    unresolved ： 未解決
    キーワード keyword
    NDC ndc 前方一致
    調査種別 res-type
    内容種別 con-type
    参考資料（書誌的事項等） bibl-desc 参考資料の書誌的事項と備考を検索する。
    参考資料（ISBN） bibl-isbn
    回答プロセス ans-proc
    照会先 referral
    事前調査事項 pre-res
    備考 note
    質問者区分 ptn-type
    寄与者 contri
    登録番号 sys-id 完全一致
    提供館名 lib-name
  • クエリー対象項目（調べ方マニュアル）
    項目表示名 項目名 備考
    全項目（簡易検索） anywhere 簡易検索と同範囲での検索となる。
    調査テーマ theme
    管理番号 reg-id 前方一致
    調べ方 guide
    完成／未完成 completion 完全一致
    0 ： 完成
    1 ： 未完成
    ※以下についても許可する
    complete ： 完成
    incomplete ： 未完成
    キーワード keyword
    NDC ndc 前方一致
    参考資料（書誌的事項等） bibl-desc 参考資料の書誌的事項と備考を検索する。
    参考資料（ISBN） bibl-isbn
    備考 note
    登録番号 sys-id 完全一致
    提供館名 lib-name
  • クエリー対象項目（特別コレクション）
    項目表示名 項目名 備考
    全項目（簡易検索） anywhere 簡易検索と同範囲での検索となる。
    コレクション名 col-name コレクション名、コレクション名ヨミを検索する
    管理番号 reg-id 前方一致
    内容 outline
    来歴 origin
    利用条件 restriction
    目録等 catalog
    紹介文献 literature
    所蔵点数 number
    継続 continue 完全一致
    0 ： 継続有
    1 ： 継続無
    ※以下についても許可する
    continue ： 継続有
    discontinue ： 継続無
    キーワード keyword
    NDC ndc 前方一致
    備考 note
    登録番号 sys-id 完全一致
    提供館名 lib-name
  • クエリー対象項目（参加館プロファイル）
    項目表示名 項目名 備考
    全項目（簡易検索） anywhere 簡易検索と同範囲での検索となる。
    館種 lib-type 完全一致
    下記コード値、デコード値ともに許可する。
    11 国立国会図書館(東京本館)
    12 国立国会図書館(関西館)
    13 国立国会図書館(国際子ども図書館)
    14 国立国会図書館(支部図書館)
    21 公共図書館(都道府県立)
    22 公共図書館(政令指定都市立)
    23 公共図書館(市立・特別区立)
    24 公共図書館(町村立)
    31 大学図書館(国立大学)
    32 大学図書館(公立大学)
    33 大学図書館(私立大学)
    35 大学図書館(高等専門)
    41 専門図書館(国公立)
    42 専門図書館(公益法人)
    43 専門図書館(企業)
    44 専門図書館(その他)
    51 学校図書館(高等学校)
    52 学校図書館(中学校)
    53 学校図書館(小学校)
    54 学校図書館(その他)
    90 アーカイブズ
    図書館名 lib-name 以下を検索する。
    図書館名（正式）
    図書館名（略式）
    図書館名ヨミ
    住所 address 以下を検索する。
    住所（都道府県）
    住所（市区町村）
    住所（丁目・番地）
    （＝住所（検索用））
    開館情報 open-info
    利用条件 restriction
    沿革 outline
    特色 feature
    注意事項 notes
    交通アクセス access
    ISIL isil
  • CQL接続子
    演算子 内容
    関係演算子 all スペース（全角と半角を区別しない）で区切られた複数のキーワードをAND演算で検索する。
    XXXX all "キーワード1 キーワード2"
    any ブランクで区切られた複数のキーワードをOR演算で検索する。
    XXXX any "キーワード1 キーワード2"
    = 指定キーワードでの一致検索。ブランクを含む場合はフレーズでの一致となる。
    XXXX = "キーワード1"
    論理演算 and 2つの検索句をAND条件で結合する。
    XXXX any "キーワード1" and XXXX = "キーワード2"
    or 2つの検索句をOR条件で結合する。
    XXXX any "キーワード1" or XXXX = "キーワード2"
    not 第1検索句の条件に一致するものから、第2検索句に該当するものを除外。
    XXXX any "キーワード1" not XXXX = "キーワード2"

レスポンスフィールド(XML)

  • レスポンス内には複数のデータ種別が含まれる。
  • データ種別ごとのXMLフォーマットはダウンロード・アップロード・自動取得と同じフォーマットを用いる。
レスポンスフィールド(XML)
項目名 タグ名 項目説明
第1階層 第2階層 第3階層 4階層
返却結果ルートノード result_set 【XML親要素】要素内容はなし。
ヒット数 hit_num リクエストされた検索条件に該当する事例数（ヒット数）
検索開始位置 results_get_position 検索開始位置。
・リクエストで指定されたresults_get_positionの値と同一の値を出力
・リクエストで指定されなかった場合は1(デフォルト：先頭位置から検索開始)を出力
検索結果返却件数 results_num
処理結果コード results_cd 処理の成功/失敗を格納
成功：0
エラー：1
※エラーの詳細はerr_itemノードに格納
エラー情報リストノード err_list エラーを格納するノード
エラー情報ノード err_item エラー詳細を格納するノード
複数エラーが発生した場合、繰り返し出現する
エラーコード err_code エラーコードを格納する。
エラーフィールド err_fld エラーが発生したフィールド（検索リクエストのパラメタ）を表示する。
・queryパラメタ内でのエラーの場合、該当の検索キーが出力される。
エラーメッセージ err_msg エラーメッセージを格納する。
返却結果フィールド result 要素内容はなし。検索結果が複数件になる場合、『result』タグが結果件数分表示される。
レファレンス事例 reference レファレンス事例のトップノード
レファレンス事例子要素 ［要素名］ XMLフォーマット：レファレンス事例参照
URL url 一般公開用詳細表示画面のURL
調べ方マニュアル manual 調べ方マニュアルのトップノード
調べ方マニュアル子要素 ［要素名］ XMLフォーマット：調べ方マニュアルを参照
URL url 一般公開用詳細表示画面のURL
特別コレクション collection 特別コレクションのトップノード
特別コレクション子要素 ［要素名］ XMLフォーマット：特別コレクションを参照
URL url 一般公開用詳細表示画面のURL
参加館プロファイル profile 参加館プロファイルのトップノード
参加館プロファイル子要素 ［要素名］ XMLフォーマット：参加館プロファイルを参照
URL url 一般公開用詳細表示画面のURL
レスポンスフィールド(RSS 2.0)
項目名 タグ名 項目説明 備考
第1階層 第2階層 第3階層 第4階層
返却結果ルートノード rss 【XML親要素】<rss version="2.0">。 固定値
2階層ノード channel 2階層要素。値なし。 固定値
名称 title レファレンス協同データベース 固定値
URI link https://crd.ndl.go.jp/ 固定値
配信元の概要説明 description レファレンス協同データベース検索APIによる検索結果です。 固定値
本ファイルの更新日 lastBuildDate 日付を表示。
書式は、「曜日, 日 月 年 時:分:秒 JST」
とする。（例．「Tue, 30 Jan 2012 10:00:00 JST」）
docs http://backend.userland.com/rss/ 固定値
言語 language ja 固定値
item
リソースのタイトル title 以下の値を返却
レファレンス事例：　質問（提供館名）
調べ方マニュアル：　調査テーマ（提供館名）
特別コレクションデータ：　コレクション名（提供館名）
参加館プロファイル：　図書館名		 質問、調査テーマ、コレクション名の後に、（）で囲んで提供館名を連結する。
リソースのURI link 詳細表示画面のURI
リソースの公開日 pubDate データの最終更新日
書式は、「曜日, 日 月 年 時:分:秒 JST」
とする。（例．「Tue, 30 Jan 2012 10:00:00 JST」）		 RSS規約でのpubDateタグには、リソースの公開日時を記入するが、ここではデータの最終更新日時とする。
ジャンル category 以下の値を出力する。
レファレンス事例：　キーワードおよびNDC
調べ方マニュアル：　キーワードおよびNDC
特別コレクションデータ：キーワードおよびNDC		 DBに登録がある分だけ、タグを複数個記述する。
ただし、DBに1件も登録がない場合はタグ自体を記述しない。
NDCは項目名と半角コロン（：）を先頭に付与する。
例）　NDC：XXX
リソースの概要説明 description 以下の値を返却
■レファレンス事例
回答
回答プロセス：～
事前調査事項：～
参考資料：～
参考資料：～
照会先：～
照会先：～
寄与者：～
寄与者：～
備考：～
■調べ方マニュアル
調べ方
参考資料：～
参考資料：～
備考：～
■特別コレクションデータ
内容
来歴：～
利用条件：～
目録等：～
紹介文献：～
所蔵点数：～
備考：～
■参加館プロファイル：
特色
URL：～
開館情報：～
利用条件：～
沿革：～
注意事項：～
交通アクセス：～		 「回答」「調べ方」「内容」「特色」以外の項目が存在する場合は、\nと項目名と半角コロン（：）を先頭に付与し連結する。（参加館プロファイルの先頭が\nになる場合は、先頭の\nは削除する。）
参考資料は、書誌的事項，△ISBN（備考）の形で各項目を連結する（連結記号"△"は半角スペース）。
複数存在する項目は、それぞれ先頭に「\nと項目名と半角コロン（：）」を付与して、出力する。
参加館プロファイルに何も値がない時は、タグ自体を出力しない。
ユニークなID guid 詳細表示画面のURI

処理コード

処理コードとエラー区分、エラーメッセージの一覧
コード エラー区分 エラーメッセージ
0 正常終了
0101 必須項目エラー 検索必須項目が指定されていません。
0201 パラメタエラー（複数指定） リクエストエラー:typeパラメータが複数指定されています。
0202 パラメタエラー（複数指定） リクエストエラー:queryパラメータが複数指定されています。
0203 パラメタエラー（複数指定） リクエストエラー:crt-date_fromパラメータが複数指定されています。
0204 パラメタエラー（複数指定） リクエストエラー:crt-date_toパラメータが複数指定されています。
0205 パラメタエラー（複数指定） リクエストエラー:reg-date_fromパラメータが複数指定されています。
0206 パラメタエラー（複数指定） リクエストエラー:reg-date_toパラメータが複数指定されています。
0207 パラメタエラー（複数指定） リクエストエラー:lst-date_fromパラメータが複数指定されています。
0208 パラメタエラー（複数指定） リクエストエラー:lst-date_toパラメータが複数指定されています。
0209 パラメタエラー（複数指定） リクエストエラー:lib-idパラメータが複数指定されています。
0210 パラメタエラー（複数指定） リクエストエラー:lib-groupパラメータが複数指定されています。
0211 パラメタエラー（複数指定） リクエストエラー:results_formatパラメータが複数指定されています。
0212 パラメタエラー（複数指定） リクエストエラー:results_get_positionパラメータが複数指定されています。
0213 パラメタエラー（複数指定） リクエストエラー:results_numパラメータが複数指定されています。
0214 パラメタエラー（複数指定） リクエストエラー:sortパラメータが複数指定されています。
0215 パラメタエラー（複数指定） リクエストエラー:sort_orderパラメータが複数指定されています。
0301 パラメタエラー（指定値誤り） リクエストエラー:typeに使用できない値が指定されています。
0302 パラメタエラー（指定値誤り） リクエストエラー:lib-idに使用できない値が指定されています。
0303 パラメタエラー（指定値誤り） リクエストエラー:lib-groupに使用できない値が指定されています。
0304 パラメタエラー（指定値誤り） リクエストエラー:results_formatに使用できない値が指定されています。
0305 パラメタエラー（指定値誤り） リクエストエラー:results_get_positionに使用できない値が指定されています。
0306 パラメタエラー（指定値誤り） リクエストエラー:results_numに使用できない値が指定されています。
0307 パラメタエラー（指定値誤り） リクエストエラー:sortに使用できない値が指定されています。
0308 パラメタエラー（指定値誤り） リクエストエラー:sort_orderに使用できない値が指定されています。
0309 パラメタエラー（指定値誤り） typeにallが指定されていますが、queryにanywhere以外が指定されています。
0401 パラメタエラー（フォーマット誤り） リクエストエラー:crt-date_fromのフォーマットが誤っています（YYYYMMDD）。
0402 パラメタエラー（フォーマット誤り） リクエストエラー:crt-date_toのフォーマットが誤っています（YYYYMMDD）。
0403 パラメタエラー（フォーマット誤り） リクエストエラー:reg-date_fromのフォーマットが誤っています（YYYYMMDD）。
0404 パラメタエラー（フォーマット誤り） リクエストエラー:reg-date_toのフォーマットが誤っています（YYYYMMDD）。
0405 パラメタエラー（フォーマット誤り） リクエストエラー:lst-date_fromのフォーマットが誤っています（YYYYMMDD）。
0406 パラメタエラー（フォーマット誤り） リクエストエラー:lst-date_toのフォーマットが誤っています（YYYYMMDD）。
0407 パラメタエラー（日付範囲誤り） リクエストエラー:crt-date_fromとcrt-date_toの範囲指定が誤っています。
0408 パラメタエラー（日付範囲誤り） リクエストエラー:reg-date_fromとreg-date_toの範囲指定が誤っています。
0409 パラメタエラー（日付範囲誤り） リクエストエラー:lst-date_fromとlst-date_toの範囲指定が誤っています。
0501 CQL誤り（構文エラー） CQLの構文が誤っています。
0502 CQL誤り（項目名誤り） 存在しない項目名がqueryに指定されています。
0503 CQL誤り（指定値誤り） 【項目名】に使用できない値が指定されています。
0504 CQL誤り（フォーマット誤り） 【項目名】に指定された値のフォーマットが誤っています。
0901 システムエラー リクエスト処理中にエラーが発生しました
0902 GETメソッド以外 GETメソッドでリクエストしてください