本文へ

レファレンス協同データベース事業
 サイトマップ  お知らせ一覧  FAQ

レファレンス協同データベース・システム操作マニュアル(参加館用)



データ種別XMLフォーマット

XMLフォーマット:レファレンス事例
ダウンロード、検索API2.0、登録時(アップロード、自動取得機能)XMLのフォーマットは基本的に同一のものとする。
ただし、ダウンロードと登録時のタグ名は大文字(ローカル項目内容タグは除く)、検索API2.0のタグ名は小文字となっている。

  ダウンロード時・検索APIの出力について
  • 項目説明に[省略可]の記載がある項目について登録済みの値がない場合、タグが出力されない。
  • 項目説明に[複数可]の記載がある項目について、複数の値が存在する場合、同一タグが繰り返し出力される。
  • 項目説明に[必須]の記載がある項目について、登録データには必ず何らかの値があるものとし、必ず出力される。
項目名 レファ協システムDB
レファレンス事例テーブル
項目名
登録時 ダウンロード API2.0返却 タグ名 項目説明
必須:◎
任意:○
繰り返し可 第1階層 第2階層 第3階層 4階層
レファレンス協同データベース【XML親要素】 (対応なし) CRD 要素内容はなし。
必須。
『REFERENCE』の親要素である。
属性として『version』を持つ。
version:レファ協のXMLフォーマットのバージョン
属性『version』は省略可。
省略時「1.0」。(ダウンロード時は必ず出力される)
レファレンス (対応なし) REFERENCE 要素内容はなし。
必須。複数可。
各データノードの親要素である。
登録時は、属性として『type』を持つ。
設定可能な値は(「update」「delete」)
updateは省略可能。
管理番号+提供館コード が既存データと合致しない場合、新規登録として扱われる。
質問 質問 QUESTION 要素内容は、質問。
必須。
公開レベル 公開レベル ACC-LEVEL 要素内容は、公開レベル(半角数字「1(自館のみ参照)」「2(参加館公開)」「3(一般公開)」の何れか)
必須。
※検索用API2.0は「3(一般公開)」のみを対象とするため、出力しない。
管理番号 管理番号 REG-ID 要素内容は、管理番号。
必須。
回答 回答 ANSWER 要素内容は、回答。
省略可。
※登録時、公開レベルが「1(自館のみ参照)」の場合に限り省略可。残りの公開レベルでは必須。
※検索API2.0は、公開レベルが「3(一般公開)」のみのため必須。
事例作成日 事例作成日(表示用) CRT-DATE 要素内容は、事例作成日(※1)。
省略可。
※ダウンロード時特定のフォーマットではなく、登録された値【事例作成日(表示用)に格納された値】を出力する(登録されていない場合は出力しない)。
※検索API2.0ではYYYYMMDD形式で出力する(事例作成日が登録されていないまたはYYYYMMDD形式に変換できない場合は「00000000」と出力される)。
解決/未解決 解決/未解決 SOLUTION 要素内容は、解決/未解決のフラグ(半角数字「0(解決)」「1(未解決」)。
省略可。
キーワード キーワード KEYWORD 要素内容として、キーワードを持つ。
省略可。複数可。
分類 (type:対応なし)
version:NDCの版
NDC
CLASS 要素内容は分類の番号。
省略可。複数可。
属性として『type』『version』を持つ。
type:分類の種類(「NDC」のみ)
version:typeで指定された分類のバージョン(例 9(9版を示す))
属性『type』『version』は省略可。省略時は、typeはNDC、versionは空文字として処理される。
調査種別 調査種別 RES-TYPE 要素内容は調査種別(「文献紹介」「事実調査」「書誌的事項調査」「所蔵調査」「所蔵機関調査」「利用案内」「その他」または任意の文字列)。
省略可。
内容種別 内容種別 CON-TYPE 要素内容は内容種別(「郷土」「人物」「言葉」「地名」または任意の文字列)。
省略可。
参考資料 (対応なし) BIBL 要素内容はなし。
省略可。複数可。
『BIBL-DESC』『BIBL-ISBN』『BIBL-NOTE』の親要素である。
書誌的事項(参考資料) 参考資料-書誌的事項 BIBL-DESC 要素内容は参考資料の書誌的事項。
省略可。
ISBN(参考資料) 参考資料-ISBN BIBL-ISBN 要素内容は参考資料のISBN。
省略可。
備考(参考資料) 参考資料-備考 BIBL-NOTE 要素内容は参考資料の備考。
省略可。
回答プロセス 回答プロセス ANS-PROC 要素内容は回答プロセス。
省略可。
照会先 照会先 REFERRAL 要素内容は照会先。
省略可。複数可。
事前調査事項 事前調査事項 PRE-RES 要素内容は事前調査事項。
省略可。
備考 備考 NOTE 要素内容は備考。
省略可。
質問者区分 質問者区分 PTN-TYPE 要素内容は質問者区分(「未就学児」「小中学生」「高校生」「学生」「社会人」「団体」「図書館」または任意の文字列)。
省略可。
寄与者 寄与者 CONTRI 要素内容は寄与者。
省略可。複数可。
その他の項目(システム管理項目) (対応なし) SYSTEM 要素内容はなし。省略可。『REG-DATE』『LST-DATE』『SYS-ID』『LIB-ID』『LIB-NAME』『FILE-NUM』の親要素である。
登録日時 登録日時 REG-DATE 要素内容は登録日時。
YYYYMMDDhhmmss の形式で出力される。
最終更新日時 更新日時 LST-DATE 要素内容は更新日時。
YYYYMMDDhhmmss の形式で出力される。
登録番号 システムID(登録番号) SYS-ID 要素内容は登録番号。
提供館コード 図書館コード※ LIB-ID 要素内容は参加館コード。
提供館のシステムIDを用いて参加館プロファイルテーブルより取得。
提供館名 図書館名(正式)※ LIB-NAME 要素内容は提供館名。
関連ファイル数 (対応なし) FILE-NUM 関連ファイルの登録がある場合は登録数を表示する。
登録がない場合は「0」を返却する。
ローカル項目 (対応なし) LOCAL 要素内容はなし。
省略可。
ローカル項目内容 ローカル項目 [項目英名] 要素内容はローカル項目の内容。複数記載可能。省略可。同項目複数可。
URL (対応なし) URL API2.0のみ。一般公開用詳細表示画面のURLを返却。

※1 事例作成日・調べ方作成日のフォーマットについて
 日付の変換機能により、下記の形式のものは検索用データはYYYYMMDD形式に変換されます。
  • 年月日の間に区切り文字(「/(スラッシュ)」「.(ピリオド)」「-(ハイフン)」を用いて表記されるもの。
    (例「2003/04/01」「2004.05.09」「2005-09-21」)
  • 区切り文字を使用した場合、「0」を省略した形式。(例「2003-1-15」「2003/3/3」)
  • 年月日の値の後ろに区切り文字として「年月日」の文字を加えてあるもの。
    (例「2004年3月3日」「2005年7月15日」)
  • 和暦で入力されているもの。
    ただし、元号が「M、T、S、H」、もしくは「明治、大正、昭和、平成」のいずれかで表記されている事。
    (例「H14.12.10」「S45-12-25」「H2年6月11日」「昭和12年3月4日」)
  • 上記までの表示形式のうち、全てが全角で入力されているもの。 (例「2003/10/15」「H15.12.31」)


XMLフォーマット:調べ方マニュアル
ダウンロード、検索API2.0、登録時(アップロード、自動取得機能)XMLのフォーマットは基本的に同一のものとする。
ただし、ダウンロードと登録時のタグ名は大文字、API2.0のタグ名は小文字となっている。

  ダウンロード時・検索APIの出力について
  • 項目説明に[省略可]の記載がある項目について登録済みの値がない場合、タグが出力されない。
  • 項目説明に[複数可]の記載がある項目について、複数の値が存在する場合、同一タグが繰り返し出力される。
  • 項目説明に[必須]の記載がある項目について、登録データには必ず何らかの値があるものとし、必ず出力される。
項目名 レファ協システムDB
調べ方マニュアルテーブル
項目名
登録時 ダウンロード API2.0返却 タグ名 項目説明
必須:◎
任意:○
繰り返し可 第1階層 第2階層 第3階層 4階層
レファレンス協同データベース【XML親要素】 (対応なし) CRD 要素内容はなし。
必須。
『MANUAL』の親要素である。
属性として『version』を持つ。
version:レファ協のXMLフォーマットのバージョン
属性『version』は省略可。省略時「1.0」。(ダウンロード時は必ず出力される)
調べ方マニュアル【XML親要素】 (対応なし) MANUAL 要素内容はなし。
必須。複数可。
各データノードの親要素である。
登録時は、属性として『type』を持つ。
設定可能な値は(「update」「delete」)
updateは省略可能。
管理番号+提供館コード が既存データと合致しない場合、新規登録として扱われる。
調査テーマ 調査テーマ THEME 要素内容は、調査テーマ。
必須。
公開レベル 公開レベル ACC-LEVEL 要素内容は、公開レベル(半角数字「1(自館のみ参照)」「2(参加館公開)」「3(一般公開)」の何れか)
必須。
※検索用API2.0は「3(一般公開)」のみを対象とするため、出力しない。
管理番号 管理番号 REG-ID 要素内容は、管理番号。
必須。
調べ方 調べ方 GUIDE 要素内容は、調べ方。
必須。
調べ方作成日 調べ方作成日(表示用) CRT-DATE 要素内容は、調べ方作成日(レファレンス事例の※1参照)。
省略可。
※ダウンロード時特定のフォーマットではなく、登録された値【調べ方作成日(表示用)に格納された値】を出力する(登録されていない場合は出力しない)。
※検索API2.0ではYYYYMMDD形式で出力する(調べ方作成日が登録されていないまたはYYYYMMDD形式に変換できない場合は「00000000」と出力される)。
完成/未完成 完成/未完成 COMPLETION 要素内容は、完成/未完成のフラグ(半角数字「1(完成)」「2(未完成」)。
省略可。
キーワード キーワード KEYWORD 要素内容として、キーワードを持つ。
省略可。複数可。
分類 (type:対応なし)
version:NDCの版
NDC
CLASS 要素内容は分類の番号。
省略可。複数可。
属性として『type』『version』を持つ。
type:分類の種類(「NDC」のみ)
version:typeで指定された分類のバージョン(例 9(9版を示す))
属性『type』『version』は省略可。省略時は、typeはNDC、versionは空文字として処理される。
参考資料 (対応なし) BIBL 要素内容はなし。
省略可。複数可。
『BIBL-DESC』『BIBL-ISBN』『BIBL-NOTE』の親要素である。
書誌的事項(参考資料) 参考資料-書誌的事項 BIBL-DESC 要素内容は参考資料の書誌的事項。
省略可。
ISBN(参考資料) 参考資料-ISBN BIBL-ISBN 要素内容は参考資料のISBN。
省略可。
備考(参考資料) 参考資料-備考 BIBL-NOTE 要素内容は参考資料の備考。
省略可。
備考 備考 NOTE 要素内容は備考。
省略可。
その他の項目(システム管理項目) (対応なし) SYSTEM 要素内容はなし。省略可。『REG-DATE』『LST-DATE』『SYS-ID』『LIB-ID』『LIB-NAME』『FILE-NUM』の親要素である。
登録日時 登録日時 REG-DATE 要素内容は登録日時。必須。
YYYYMMDDhhmmss の形式で出力される。
最終更新日時 更新日時 LST-DATE 要素内容は更新日時。
YYYYMMDDhhmmss の形式で出力される。
登録番号 システムID(登録番号) SYS-ID 要素内容は登録番号。
提供館コード 図書館コード※ LIB-ID 要素内容は提供館コード。
提供館名 図書館名(正式)※ LIB-NAME 要素内容は提供館名。
関連ファイル数 (対応なし) FILE-NUM 関連ファイルの登録がある場合は登録数を表示する。
登録がない場合は「0」を返却する。
ローカル項目 (対応なし) LOCAL 要素内容はなし。
省略可。
ローカル項目内容 ローカル項目 [項目英名] 要素内容はローカル項目の内容。複数記載可能。省略可。同項目複数可。
URL (対応なし) URL API2.0のみ。一般公開用詳細表示画面のURL


XMLフォーマット:特別コレクション
ダウンロード、検索API2.0、登録時(アップロード、自動取得機能)XMLのフォーマットは基本的に同一のものとする。
ただし、ダウンロードと登録時のタグ名は大文字、API2.0のタグ名は小文字となっている。

  ダウンロード時・検索APIの出力について
  • 項目説明に[省略可]の記載がある項目について登録済みの値がない場合、タグが出力されない。
  • 項目説明に[複数可]の記載がある項目について、複数の値が存在する場合、同一タグが繰り返し出力される。
  • 項目説明に[必須]の記載がある項目について、登録データには必ず何らかの値があるものとし、必ず出力される。
項目名 レファ協システムDB
特別コレクションテーブル
項目名
登録時 ダウンロード API2.0返却 タグ名 項目説明
必須:◎
任意:○
繰り返し可 第1階層 第2階層 第3階層 4階層
レファレンス協同データベース【XML親要素】 (対応なし) CRD 要素内容はなし。
必須。
『COLLECTION』の親要素である。
属性として『version』を持つ。
version:レファ協のXMLフォーマットのバージョン
属性『version』は省略可。省略時「1.0」。(ダウンロード時は必ず出力される)
特別コレクション (対応なし) COLLECTION 要素内容はなし。
必須。複数可。
各データノードの親要素である。
登録時は、属性として『type』を持つ。
設定可能な値は(「update」「delete」)
updateは省略可能。
管理番号+提供館コード が既存データと合致しない場合、新規登録として扱われる。
コレクション名 コレクション名 COL-NAME 要素内容はコレクション名。必須。
コレクション名ヨミ コレクション名ヨミ PRO-KEY 要素内容はコレクション名ヨミ。必須。
公開レベル 公開レベル ACC-LEVEL 要素内容は、公開レベル(半角数字「1(自館のみ参照)」「2(参加館公開)」「3(一般公開)」の何れか)
必須。
※検索用API2.0は「3(一般公開)」のみを対象とするため、出力しない。
管理番号 管理番号 REG-ID 要素内容は、管理番号。
必須。
内容 内容 OUTLINE 要素内容は内容。必須。
来歴 来歴 ORIGIN 要素内容は来歴。省略可。
利用条件 利用条件
RESTRICTION
要素内容は利用条件。省略可。
目録等 目録等 CATALOG 要素内容は目録等。省略可。
紹介文献 紹介文献 LITERATURE 要素内容は紹介文献。省略可。
所蔵点数 所蔵点数 NUMBER 要素内容は所蔵点数。省略可。
継続 継続 CONTINUE 要素内容は、継続のフラグ(半角数字「0(継続有)」「1(継続無」)。
省略可。
キーワード キーワード KEYWORD 要素内容として、キーワードを持つ。
省略可。複数可。
分類 (type:対応なし)
version:NDCの版
NDC
CLASS 要素内容は分類の番号。
省略可。複数可。
属性として『type』『version』を持つ。
type:分類の種類(「NDC」のみ)
version:typeで指定された分類のバージョン(例 9(9版を示す))
属性『type』『version』は省略可。省略時は、typeはNDC、versionは空文字として処理される。
備考 備考 NOTE 要素内容は備考。
省略可。
その他の項目(システム管理項目) (対応なし) SYSTEM 要素内容はなし。省略可。『REG-DATE』『LST-DATE』『SYS-ID』『LIB-ID』『LIB-NAME』『FILE-NUM』の親要素である。
登録日時 登録日時 REG-DATE 要素内容は登録日時。
YYYYMMDDhhmmss の形式で出力される。
最終更新日時 更新日時 LST-DATE 要素内容は更新日時。
YYYYMMDDhhmmss の形式で出力される。
登録番号 システムID(コレクションID) SYS-ID 要素内容は登録番号。
提供館コード 図書館コード※ LIB-ID 要素内容は提供館コード。
提供館名 図書館名(正式)※ LIB-NAME 要素内容は提供館名。
関連ファイル数 (対応なし) FILE-NUM 関連ファイルの登録がある場合は登録数を表示する。
登録がない場合は「0」を返却する。
ローカル項目 (対応なし) LOCAL 要素内容はなし。
省略可。
ローカル項目内容 ローカル項目 [項目英名] 要素内容はローカル項目の内容。複数記載可能。省略可。同項目複数可
URL (対応なし) URL API2.0のみ。一般公開用詳細表示画面のURL


XMLフォーマット:参加館プロファイル
ダウンロード、検索API2.0、登録時(アップロード、自動取得機能)XMLのフォーマットは基本的に同一のものとする。
ただし、ダウンロードと登録時のタグ名は大文字、API2.0のタグ名は小文字となっている。

  ダウンロード時・検索APIの出力について
  • 項目説明に[省略可]の記載がある項目について登録済みの値がない場合、タグが出力されない。
  • 項目説明に[複数可]の記載がある項目について、複数の値が存在する場合、同一タグが繰り返し出力される。
  • 項目説明に[必須]の記載がある項目について、登録データには必ず何らかの値があるものとし、必ず出力される。
項目名 レファ協システムDB
参加館プロファイルテーブル
項目名
ダウンロード API2.0返却 タグ名 項目説明
第1階層 第2階層 第3階層 4階層
レファレンス協同データベース【XML親要素】 (対応なし) CRD 要素内容はなし。
必須。
『PROFILE』の親要素である。
属性として『version』を持つ。
version:レファ協のXMLフォーマットのバージョン
属性『version』は「1.0」が出力される。
参加館プロファイル (対応なし) PROFILE 要素内容はなし。
必須。複数可。
各データノードの親要素である。
館種 館種コード LIB-TYPE 要素内容は館種コード(コード値)。
必須。
公開レベル 公開レベル ACC-LEVEL 要素内容は、公開レベル(半角数字「1(自館のみ参照)」「2(参加館公開)」「3(一般公開)」の何れか)
必須。
※検索用API2.0は「3(一般公開)」のみを対象とするため、出力しない。
図書館名(正式) 図書館名(正式) LIB-NAME 要素内容は図書館名(正式)。必須。
図書館名(略式) 図書館名(略式) ABBR 要素内容は図書館名(略式)。必須。
図書館名ヨミ 図書館名ヨミ PRO-KEY 要素内容は図書館名ヨミ。必須。
郵便番号 郵便番号 ZIP-CODE 要素内容は郵便番号。必須。
住所(都道府県) 住所(都道府県) ADD-PREF 要素内容は住所(都道府県)。必須。
住所(市区町村) 住所(市区町村) ADD-CITY 要素内容は住所(市区町村)。必須。
住所(丁目・番地) 住所(丁目・番地) ADD-STREET 要素内容は住所(丁目・番地)。必須。
電話番号1 電話番号1 TEL1 要素内容は電話番号1。必須。
電話番号1(追加情報) 電話番号1(追加情報) TEL1-NOTE 要素内容は電話番号1(追加情報)。省略可。
E-MAIL(管理者) E-MAIL(管理者) EMAIL-ADMIN 要素内容はE-MAIL(管理者)。必須。
E-MAIL(コメント通知) E-MAIL(コメント通知) EMAIL-COMMENT 要素内容はE-MAIL(コメント通知)。必須。
E-MAIL(未解決事例通知) E-MAIL(未解決事例通知) EMAIL-UNRESOLVED 要素内容はE-MAIL(未解決事例通知)。省略可。
電話番号2 電話番号2 TEL2 要素内容は電話番号2。省略可。
電話番号2(追加情報) 電話番号2(追加情報) TEL2-NOTE 要素内容は電話番号2(追加情報)。省略可。
電話番号3 電話番号3 TEL3 要素内容は電話番号3。省略可。
電話番号3(追加情報) 電話番号3(追加情報) TEL3-NOTE 要素内容は電話番号3(追加情報)。省略可。
FAX番号 FAX番号 FAX 要素内容はFAX番号。省略可。
E-MAIL(公開) E-MAIL(公開) E-MAIL 要素内容はE-MAIL(公開)。省略可。
URL URL LIB-URL 要素内容はURL。省略可。
開館情報 開館情報 OPEN-INFO 要素内容は開館情報。省略可。
利用条件 利用条件 RESTRICTION 要素内容は利用条件。省略可。
沿革 沿革 OUTLINE 要素内容は沿革。省略可。
特色 特色 FEATURE 要素内容は特色。省略可。
注意事項 注意事項 NOTES 要素内容は注意事項。省略可。
交通アクセス 交通アクセス ACCESS 要素内容は交通アクセス。省略可。
ISIL ISIL ISIL 要素内容はISIL。複数番号が連結して入力されている場合がある。
省略可。
その他の項目(システム管理項目) (対応なし) SYSTEM 要素内容はなし。値がない場合はタグが出力されない。『REG-DATE』『LST-DATE』『LIB-ID』『FILE-NUM』の親要素である。
登録日時 登録日時 REG-DATE 要素内容は登録日時。必須。
YYYYMMDDhhmmss の形式で出力される。
最終更新日時 更新日時 LST-DATE 要素内容は更新日時。必須。
YYYYMMDDhhmmss の形式で出力される。
図書館コード 図書館コード LIB-ID 要素内容は図書館コード。
関連ファイル数 (対応なし) FILE-NUM 関連ファイルの登録がある場合は登録数を表示する。
登録がない場合は「0」を返却する。
ローカル項目 (対応なし) LOCAL 要素内容はなし。
省略可。
ローカル項目内容 ローカル項目 [項目英名] 要素内容はローカル項目の内容。複数記載可能。省略可。同項目複数可。
URL (対応なし) URL API2.0のみ。一般公開用詳細表示画面のURL。




Copyright (C) 2005- National Diet Library. All Rights Reserved.