変 更 履 歴 No 版 数 更 新 日 変 更 箇 所 変 更 内 容 版 2014/12/ 応 答 結 果 XML AmendDoc DocType DocName を 追 記 版 2014/12/ 応 答 結 果 XML エラー 時

Transcription

1 1.9 版 2015 年 12 月 21 日

2 変 更 履 歴 No 版 数 更 新 日 変 更 箇 所 変 更 内 容 版 2014/12/ 応 答 結 果 XML AmendDoc DocType DocName を 追 記 版 2014/12/ 応 答 結 果 XML エラー 時 に 返 却 する HTML の 内 容 を 修 正 版 2015/2/18 3.API の 利 用 方 法 エスケープ 処 理 対 象 文 字 を 追 記 版 2015/2/ 応 答 結 果 XML Status の 桁 数 を 修 正 取 得 件 数 の 上 限 値 を 追 記 版 2015/2/ 応 答 結 果 XML Status の 桁 数 を 修 正 版 2015/2/18 10.ファイルサイズの 大 き い 申 請 データを 申 請 する 場 合 の 留 意 事 項 ファイルサイズの 大 きい 申 請 デー タを 申 請 する 場 合 の 留 意 事 項 を 追 記 版 2015/2/18 別 紙 2 コー 別 紙 2 コードリフ ドリファレンス ァレンスを 新 規 作 成 版 2015/3/ 送 信 パラメータ 送 信 パラメータの Signature> 送 信 パラメータ SignedInfo>Reference> 送 信 パラメータ Transforms 配 下 に Transform タグ 送 信 パラメータ を 追 加 送 信 パラメータ 公 文 書 署 名 検 証 における 版 2015/3/ 送 信 パラメータ FileData と SigVerificationXMLFileName の に 関 する 説 明 を 追 記 Request Rejected 応 答 結 果 として Request 版 2015/3/5 の HTML が 応 答 される 場 合 について Rejected の HTML が 応 答 される 場 合 の 留 意 事 項 を 追 記 版 2015/3/ 応 答 結 果 XML 応 答 結 果 XML の ApplData 配 下 AccessKey の 誤 記 を 修 正 修 正 前 :AcccessKey 修 正 後 :AccessKey 版 2015/3/ 送 信 パラメータ 送 信 パラメータの ApplData 配 下 に (Attribute)Id を 追 加 版 2015/4/ 送 信 パラメータ 公 文 書 署 名 検 証 における FileName の に 関 する 説 明 ( 1)を 追 記 版 2015/4/ 応 答 結 果 XML 返 却 内 容 の 文 言 修 正

3 版 2015/5/ 補 正 ( 補 正 申 請 ) 補 正 内 容 の 確 認 方 法 を 修 正 版 2015/5/ 公 文 書 取 得 版 2015/5/ コメント 通 知 取 得 補 正 情 報 に 関 する 説 明 ( )を 追 記 補 正 情 報 に 関 する 説 明 ( )を 修 版 2015/5/ 送 信 パラメータ BankName の 文 字 種 を 修 正 版 2015/6/ 応 答 結 果 XML 版 2015/08/ 応 答 結 果 XML 応 答 結 果 XML 応 答 結 果 XML 応 答 結 果 XML 版 2015/12/ 申 請 後 の 申 請 ステー タス 自 動 遷 移 について 正 Initial (attribute)name の 文 字 種 を 修 正 FileName の 返 却 内 容 を 修 正 API テスト 用 手 続 の 自 動 ステータ ス 遷 移 について 追 記

4 目 次 1. の 位 置 づけ API 一 覧 一 覧 の 概 要 利 用 者 ID 登 録 利 用 者 認 証 一 括 申 請 送 信 案 件 一 覧 情 報 取 得 申 請 案 件 一 覧 情 報 取 得 状 況 照 会 取 下 げ 補 正 通 知 一 覧 情 報 取 得 補 正 ( 再 提 出 ) 補 正 ( 部 分 補 正 ) 補 正 ( 補 正 申 請 ) 公 文 書 コメント 一 覧 取 得 公 文 書 取 得 公 文 書 取 得 完 了 公 文 書 署 名 検 証 コメント 通 知 取 得 コメント 通 知 取 得 完 了 電 子 納 付 対 応 金 融 機 関 一 覧 取 得 納 付 情 報 一 覧 取 得 電 子 納 付 金 融 機 関 サイト 表 示 証 明 書 識 別 情 報 追 加 証 明 書 識 別 情 報 更 新 証 明 書 識 別 情 報 削 除 API の 利 用 方 法 利 用 者 ID 登 録 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード i

5 3.2. 利 用 者 認 証 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 一 括 申 請 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 送 信 案 件 一 覧 情 報 取 得 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 申 請 案 件 一 覧 情 報 取 得 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 状 況 照 会 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 取 下 げ リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 補 正 通 知 一 覧 取 得 ii

6 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 補 正 ( 再 提 出 ) リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 補 正 ( 部 分 補 正 ) リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 補 正 ( 補 正 申 請 ) リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 公 文 書 コメント 一 覧 取 得 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 公 文 書 取 得 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 公 文 書 取 得 完 了 リクエスト URI iii

7 URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 公 文 書 署 名 検 証 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード コメント 通 知 取 得 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード コメント 通 知 取 得 完 了 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 電 子 納 付 対 応 金 融 機 関 一 覧 取 得 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 納 付 情 報 一 覧 取 得 リクエスト URI URI パラメータ 送 信 パラメータ 結 果 XML HTTP レスポンスコード 電 子 納 付 金 融 機 関 サイト 表 示 リクエスト URI URI パラメータ iv

8 送 信 パラメータ 応 答 結 果 HTML 証 明 書 識 別 情 報 追 加 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 証 明 書 識 別 情 報 更 新 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード 証 明 書 識 別 情 報 削 除 リクエスト URI URI パラメータ 送 信 パラメータ 応 答 結 果 XML HTTP レスポンスコード メッセージ ステータス 管 理 メインステータス サブステータス 納 付 状 況 申 請 後 の 申 請 ステータス 自 動 遷 移 について コード 定 義 処 理 結 果 コード 取 下 げ 可 能 フラグ 取 下 げ 方 法 補 正 可 能 フラグ 基 本 情 報 申 請 書 補 正 フラグ 基 本 情 報 添 付 資 料 補 正 フラグ 有 効 期 限 フラグ 納 付 フラグ 申 請 データと 到 達 番 号 の 対 応 付 け 検 証 環 境 を 利 用 するための 留 意 事 項 v

9 8.1. Basic 認 証 リクエスト URI HTTP リクエストのボディ 部 に 指 定 する XML の 電 子 署 名 情 報 について HTTP ボディ 部 に 指 定 する XML に 対 する 電 子 署 名 の 考 え 方 HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 構 成 HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 設 定 例 留 意 事 項 ファイルサイズの 大 きい 申 請 データを 申 請 する 場 合 の 留 意 事 項 Request Rejected の HTML が 応 答 される 場 合 について vi

10 1. の 位 置 づけ は API 利 用 ソフトウェアが e-gov 電 子 申 請 システムに 対 して 電 子 申 請 を 行 うためのリクエスト URI とそのパラメータ 処 理 要 求 を 行 う XML 及 び e-gov 電 子 申 請 シス テムが 返 却 する 応 答 XML に 関 する 仕 様 について 記 載 するものです 一 括 申 請 取 下 げ 補 正 ( 再 提 出 ) 補 正 ( 部 分 補 正 ) 補 正 ( 補 正 申 請 )における 申 請 データ 構 造 に 関 する 仕 様 については 申 請 データ 仕 様 書 共 通 データ 仕 様 書 を 参 照 してください API 利 用 ソフトウェアの 開 発 者 が ソフトウェアを 開 発 する 上 で 遵 守 すべきセキュリティ 要 求 事 項 につい ては 情 報 セキュリティ 要 求 仕 様 書 を 参 照 してください 図 1-1 の 位 置 づけ 1

11 2. API 一 覧 は 利 用 用 途 に 応 じ 23 の API から 構 成 されます 2.1. 一 覧 表 2-1 一 覧 API 1 利 用 者 ID 登 録 2 利 用 者 認 証 3 一 括 申 請 4 送 信 案 件 一 覧 情 報 取 得 5 申 請 案 件 一 覧 情 報 取 得 6 状 況 照 会 7 取 下 げ 8 補 正 通 知 一 覧 取 得 9 補 正 ( 再 提 出 ) 10 補 正 ( 部 分 補 正 ) 11 補 正 ( 補 正 申 請 ) 厚 生 労 働 省 所 管 手 続 き 12 公 文 書 コメント 一 覧 取 得 13 公 文 書 取 得 14 公 文 書 取 得 完 了 15 公 文 書 署 名 検 証 16 コメント 通 知 取 得 17 コメント 通 知 取 得 完 了 18 電 子 納 付 対 応 金 融 機 関 一 覧 取 得 19 納 付 情 報 一 覧 取 得 20 電 子 納 付 金 融 機 関 サイト 表 示 WEB ブラウザ 起 動 を 前 提 とする 21 証 明 書 識 別 情 報 追 加 22 証 明 書 識 別 情 報 更 新 23 証 明 書 識 別 情 報 削 除 2

12 2.2. の 概 要 利 用 者 ID 登 録 API 利 用 ソフトウェアからの 利 用 者 登 録 要 求 を 受 け 付 け 要 求 された 利 用 者 情 報 を 登 録 し 処 理 結 果 を 応 答 します 利 用 者 認 証 API 利 用 ソフトウェアからの 利 用 者 認 証 要 求 を 受 け 付 け アクセスキーを 発 行 します また ア クセスキーを 含 む 認 証 結 果 を 応 答 します 一 括 申 請 API 利 用 ソフトウェアからの 一 括 申 請 要 求 を 受 け 付 け 申 請 データ 仕 様 書 共 通 データ 仕 様 書 に 準 拠 して 作 成 された 1 件 以 上 の 申 請 データを 受 け 付 け 送 信 番 号 等 を 応 答 します 送 信 案 件 一 覧 情 報 取 得 API 利 用 ソフトウェアからの 送 信 案 件 一 覧 情 報 取 得 要 求 を 受 け 付 け 指 定 された 条 件 ( 送 信 番 号 または 取 得 対 象 期 間 )に 合 致 する 送 信 案 件 情 報 を 抽 出 し 以 下 の 情 報 を 応 答 します 1 一 括 申 請 された 件 数 や 正 常 に 到 達 した 件 数 と 形 式 チェック 等 の 処 理 状 況 2 形 式 チェック 等 でエラーとなった 申 請 データ 件 数 とその 内 容 3 正 常 に 到 達 した 申 請 内 容 ( 到 達 番 号 手 続 名 識 別 情 報 申 請 者 氏 名 等 )と 申 請 状 況 取 得 対 象 期 間 を 条 件 指 定 することで 複 数 の 送 信 案 件 情 報 を 取 得 することができます 申 請 案 件 一 覧 情 報 取 得 API 利 用 ソフトウェアからの 申 請 案 件 一 覧 情 報 取 得 要 求 を 受 け 付 け 指 定 された 条 件 ( 送 信 番 号 ) に 合 致 する 申 請 案 件 情 報 を 抽 出 し 以 下 の 情 報 を 応 答 します 1 正 常 に 到 達 した 件 数 2 形 式 チェック 等 でエラーとなった 申 請 データ 件 数 とその 内 容 3 正 常 に 到 達 した 申 請 内 容 ( 到 達 番 号 手 続 名 識 別 情 報 申 請 者 氏 名 等 )と 申 請 状 況 特 定 の 送 信 番 号 を 条 件 指 定 することで 該 当 する 送 信 番 号 の 送 信 案 件 情 報 を 取 得 することができ ます 状 況 照 会 API 利 用 ソフトウェアからの 状 況 照 会 要 求 を 受 け 付 け 指 定 された 条 件 ( 到 達 番 号 )に 合 致 する 申 請 案 件 の 申 請 状 況 ( 到 達 番 号 手 続 名 到 達 日 時 処 理 状 況 等 )を 応 答 します 3

13 取 下 げ API 利 用 ソフトウェアからの 取 下 げ 要 求 を 受 け 付 け 指 定 された 到 達 番 号 の 申 請 が 取 下 げ 可 能 で ある 場 合 取 下 げ 依 頼 を 行 い 処 理 結 果 を 応 答 します 補 正 通 知 一 覧 情 報 取 得 API 利 用 ソフトウェアからの 補 正 通 知 一 覧 取 得 要 求 を 受 け 付 け 指 定 された 条 件 ( 到 達 番 号 )に 合 致 する 補 正 通 知 一 覧 ( 到 達 番 号 手 続 名 補 正 要 求 日 時 補 正 対 応 期 限 補 正 通 知 ファイル 名 ) を 応 答 します 補 正 ( 再 提 出 ) API 利 用 ソフトウェアからの 補 正 ( 再 提 出 ) 要 求 を 受 け 付 け 指 定 された 到 達 番 号 を 持 つ 申 請 デ ータの 形 式 チェックを 行 い 新 たに 発 行 した 到 達 番 号 到 達 日 時 等 を 応 答 します 状 況 照 会 の 申 請 状 況 が 審 査 中 ( 補 正 待 ち) かつ 補 正 通 知 一 覧 情 報 取 得 の 補 正 種 別 が 再 提 出 の 場 合 この API を 実 行 します 補 正 ( 部 分 補 正 ) API 利 用 ソフトウェアからの 補 正 ( 部 分 補 正 ) 要 求 を 受 け 付 け 指 定 された 到 達 番 号 を 持 つ 申 請 データの 補 正 対 象 範 囲 に 応 じた 形 式 チェックを 行 い 到 達 番 号 到 達 日 時 等 を 応 答 します 状 況 照 会 の 申 請 状 況 が 審 査 中 ( 補 正 待 ち) かつ 補 正 通 知 一 覧 情 報 取 得 の 補 正 種 別 が 部 分 補 正 の 場 合 この API を 実 行 します 補 正 ( 補 正 申 請 ) API 利 用 ソフトウェアからの 補 正 ( 補 正 申 請 ) 要 求 を 受 け 付 け 指 定 された 到 達 番 号 を 持 つ 申 請 データの 形 式 チェックを 行 い 新 たに 発 行 した 到 達 番 号 到 達 日 時 等 を 応 答 します 当 API は 厚 生 労 働 省 所 管 の 手 続 が 対 象 となります 公 文 書 コメント 一 覧 取 得 により 発 出 されたものを 確 認 後 発 出 されたものに 応 じて 公 文 書 取 得 または コメン ト 通 知 取 得 により 補 正 内 容 を 確 認 します また 状 況 照 会 の 補 正 可 能 フラグが 可 の 場 合 に 処 理 可 能 です 公 文 書 コメント 一 覧 取 得 API 利 用 ソフトウェアからの 公 文 書 コメント 通 知 取 得 要 求 を 受 け 付 け 指 定 された 条 件 ( 到 達 番 号 )に 合 致 する 発 出 された 公 文 書 およびコメント 通 知 一 覧 ( 通 知 通 番 発 行 日 時 文 書 件 名 取 得 期 限 等 )を 応 答 します 厚 生 労 働 省 所 管 手 続 きの 場 合 は この API により 補 正 情 報 を 取 得 します 4

14 公 文 書 取 得 API 利 用 ソフトウェアからの 公 文 書 取 得 要 求 を 受 け 付 け 指 定 された 到 達 番 号 通 知 通 番 の 公 文 書 を ZIP 形 式 にまとめて 応 答 します 厚 生 労 働 省 所 管 手 続 きで 補 正 情 報 が 公 文 書 が 発 出 されている 場 合 は この API により 補 正 情 報 を 取 得 します 公 文 書 取 得 完 了 API 利 用 ソフトウェアから 公 文 書 取 得 完 了 要 求 を 受 け 付 け 指 定 された 到 達 番 号 通 知 通 番 の 公 文 書 を 取 得 完 了 にし 処 理 結 果 を 応 答 します 公 文 書 署 名 検 証 API 利 用 ソフトウェアからの 公 文 書 署 名 検 証 要 求 を 受 け 付 け 送 信 された 公 文 書 の 官 職 証 明 書 お よび 官 職 署 名 の 検 証 結 果 を 応 答 します コメント 通 知 取 得 API 利 用 ソフトウェアからのコメント 通 知 取 得 要 求 を 受 け 付 け 指 定 された 到 達 番 号 通 知 通 番 のコメント 通 知 を ZIP 形 式 にまとめて 応 答 します 厚 生 労 働 省 所 管 手 続 きで 補 正 情 報 に 関 するコメントが 発 出 されている 場 合 は この API により 補 正 情 報 を 取 得 します コメント 通 知 取 得 完 了 API 利 用 ソフトウェアからコメント 通 知 取 得 完 了 要 求 を 受 け 付 け 指 定 された 到 達 番 号 通 知 通 番 のコメント 通 知 を 取 得 完 了 にし 処 理 結 果 を 応 答 します 電 子 納 付 対 応 金 融 機 関 一 覧 取 得 API 利 用 ソフトウェアからの 電 子 納 付 金 融 機 関 一 覧 取 得 要 求 を 受 け 付 け 国 庫 金 の 電 子 納 付 が 可 能 な 金 融 機 関 一 覧 ( 金 融 機 関 名 ネットバンキングのサービス 名 URL 等 )を 応 答 します 納 付 情 報 一 覧 取 得 API 利 用 ソフトウェアからの 納 付 情 報 一 覧 取 得 要 求 を 受 け 付 け 指 定 された 到 達 番 号 に 発 行 され た 手 数 料 等 の 納 付 情 報 ( 到 達 番 号 納 付 番 号 確 認 番 号 収 納 期 間 番 号 等 )を 応 答 します 電 子 納 付 金 融 機 関 サイト 表 示 API 利 用 ソフトウェアが 起 動 したブラウザからの 電 子 納 付 金 融 機 関 サイト 表 示 要 求 を 受 け 付 け 金 融 機 関 のネットバンキングに 遷 移 します 他 の API とは 異 なり この API は ブラウザによる 実 行 を 前 提 としています 5

15 証 明 書 識 別 情 報 追 加 API 利 用 ソフトウェアからの 証 明 書 識 別 情 報 の 追 加 要 求 を 受 け 付 け 指 定 された 証 明 書 識 別 情 報 を 追 加 します また その 処 理 結 果 を 応 答 します 1 つの 利 用 者 ID に 対 し 複 数 の 証 明 書 識 別 情 報 を 登 録 することが 可 能 です 証 明 書 識 別 情 報 更 新 API 利 用 ソフトウェアからの 証 明 書 識 別 情 報 の 更 新 要 求 を 受 け 付 け 指 定 された 証 明 書 識 別 情 報 を 更 新 します また その 処 理 結 果 を 応 答 します 証 明 書 識 別 情 報 削 除 API 利 用 ソフトウェアからの 証 明 書 識 別 情 報 の 削 除 要 求 を 受 け 付 け 指 定 された 証 明 書 識 別 情 報 を 削 除 します また その 処 理 結 果 を 応 答 します 6

16 3. API の 利 用 方 法 は 指 定 された URI に 対 しリクエストを 送 信 することで 利 用 可 能 です API を 利 用 するには 検 証 環 境 利 用 申 込 書 または 最 終 確 認 試 験 申 込 書 による 申 込 み 後 に 受 領 するソフトウェア ID の 設 定 が 必 須 であるほか API 毎 に 所 定 のパラメータを 設 定 します 各 API は 処 理 結 果 として HTTP レスポンスコードと 共 に 処 理 結 果 が 記 述 された XML 形 式 デー タ( 応 答 結 果 XML)を 返 却 します 応 答 結 果 XML は 基 本 的 に 2 つのブロックから 構 成 されます <?xml version="1.0" encoding="utf-8"?> <DataRoot> <Result> </Result> <ApplData> </ApplData> API の 処 理 結 果 情 報 (Result タグ) API の 処 理 結 果 内 容 (ApplData タグ) </DataRoot> 図 3-1 の 応 答 結 果 XML 応 答 結 果 XML 内 の 文 字 列 は 以 下 の 対 象 文 字 をエスケープ 処 理 して 出 力 しています API 利 用 ソ フトウェアにて 必 要 に 応 じてエスケープ 処 理 後 文 字 列 を エスケープ 処 理 前 の 文 字 に 変 換 してく ださい 表 3-1 エスケープ 処 理 対 象 文 字 エスケープ 処 理 前 文 字 エスケープ 処 理 後 文 字 列 " " & & < < > > 7

17 本 仕 様 書 が 記 載 対 象 とする は バージョン 1 となります リクエスト URI の Version パラメータ 部 には 1 を 設 定 してください 以 下 に リクエスト URI の 凡 例 を 示 します リクエス ト URI の{ }の 間 が 設 定 するパラメータ 値 となります 図 3-2 リクエスト URI パラメータ 設 定 凡 例 8

18 3.1. 利 用 者 ID 登 録 リクエスト URI リクエスト URI HTTP メソッド POST e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ (attribute)id 1 英 数 字 8 ApplData UserID 1 英 数 字 12 以 下 新 規 登 録 する 利 用 者 ID Signature 署 名 情 報 (attribute)xmlns 1 半 角 1 以 上 XMLSignature の 名 前 空 間 (attribute)id 1 半 角 14 署 名 付 与 した 日 時 [yyyymmddhhmmss] SignedInfo データ CanonicalizationMethod データ SignedInfo Reference に (attribute) 1 半 角 1 以 上 対 する 正 規 化 に 使 用 する Algorithm アルゴリズム SignatureMethod データ (attribute) 1 半 角 1 以 上 SignedInfo の 署 名 値 計 算 Algorithm に 使 用 するアルゴリズム Reference データ (attribute) URI 1 半 角 1 以 上 XML の URI Transforms データ Transform 1-1 以 上 データ (attribute) Algorithm 1 半 角 1 以 上 DigestMethod データ (attribute) Algorithm 1 半 角 1 以 上 Reference 対 象 に 対 する 正 規 化 に 使 用 するアルゴ リズム Reference 対 象 に 対 する ダイジェスト 計 算 に 使 用 するアルゴリズム DigestValue 1 半 角 1 以 上 構 成 定 義 の 計 算 対 象 SignatureMethod で 指 定 SignatureValue 1 半 角 1 以 上 したアルゴリズムで 生 成 された 署 名 値 9

19 KeyInfo データ X509Data データ X509Certificate 1 半 角 1 以 上 署 名 付 与 に 使 用 した 証 明 書 の Base64 エンコード 値 上 記 XML 内 の(attribute)は 属 性 を 指 します (attribute)という ではありません Signature タグの 詳 細 ついては 9.2.HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 構 成 を 参 照 してください 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ UserID 1 英 数 字 12 以 下 新 規 登 録 した 利 用 者 ID HTTP レスポンスコード 返 却 値 内 容 201 Created 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 10

20 3.2. 利 用 者 認 証 リクエスト URI リクエスト URI HTTP メソッド POST e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ (attribute)id 1 英 数 字 8 ApplData UserID 1 英 数 字 12 認 証 する 利 用 者 ID Signature 署 名 情 報 (attribute)xmlns 1 半 角 1 以 上 XMLSignature の 名 前 空 間 (attribute)id 1 半 角 14 署 名 付 与 した 日 時 [yyyymmddhhmmss] SignedInfo データ CanonicalizationMethod データ SignedInfo Reference に (attribute) 1 半 角 1 以 上 対 する 正 規 化 に 使 用 する Algorithm アルゴリズム SignatureMethod データ (attribute) 1 半 角 1 以 上 SignedInfo の 署 名 値 計 算 Algorithm に 使 用 するアルゴリズム Reference データ (attribute) URI 1 半 角 1 以 上 XML の URI Transforms データ Transform データ (attribute) Algorithm 1 半 角 1 以 上 DigestMethod データ (attribute) Algorithm 1 半 角 1 以 上 Reference 対 象 に 対 する 正 規 化 に 使 用 するアルゴ リズム Reference 対 象 に 対 する ダイジェスト 計 算 に 使 用 するアルゴリズム DigestValue 1 半 角 1 以 上 構 成 定 義 の 計 算 対 象 SignatureMethod で 指 定 SignatureValue 1 半 角 1 以 上 したアルゴリズムで 生 成 された 署 名 値 11

21 KeyInfo データ X509Data データ X509Certificate 1 半 角 1 以 上 署 名 付 与 に 使 用 した 証 明 書 の Base64 エンコード 値 上 記 XML 内 の(attribute)は 属 性 を 指 します (attribute)という ではありません Signature タグの 詳 細 ついては 9.2.HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 構 成 を 参 照 してください 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot 処 理 結 果 Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ UserID 1 英 数 字 12 以 下 認 証 した 利 用 者 ID AccessKey 1 英 数 字 1024 以 下 アクセスキー エラー 時 は 空 前 回 成 功 した 認 証 日 時 LastAuthenticationDate 1 英 数 字 14 [yyyymmddhhmmss] エラー 時 は 空 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 12

22 3.3. 一 括 申 請 リクエスト URI リクエスト URI HTTP メソッド POST URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ Upload アップロードファイル 項 目 FileName 1 全 半 角 256 以 下 アップロードファイル 名 ZIP 形 式 にした 一 括 申 請 FileData 1 半 角 1 以 上 データを Base64 でエンコ ードしたデータ( 1) 1. 申 請 データの 構 造 及 び 形 式 は 申 請 データ 仕 様 書 共 通 データ 仕 様 書 を 参 照 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ SendNumber 1 英 数 字 18 送 信 番 号 エラー 時 は 空 SendDate 1 数 字 14 送 信 日 時 [yyyymmddhhmmss] エラー 時 は 空 SendFileName 1 全 半 角 256 以 下 送 信 ファイル 名 SendApplyCount 1 数 字 4 以 下 送 信 申 請 件 数 13

23 エラー 時 は 空 ErrorCount 1 数 字 4 以 下 エラー 件 数 エラーがない 場 合 は 0 エラー 内 容 Error n エラーがない 場 合 はタ グを 出 力 しない FolderName 1 全 半 角 256 以 下 エラーとなった 申 請 フォ ルダ 名 FileName 1 全 半 角 256 以 下 エラーとなった 申 請 ファ イル 名 Content 1 全 半 角 256 以 下 エラー 内 容 HTTP レスポンスコード 返 却 値 内 容 202 Accepted 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 413 Request Entity Too Large アップロードファイルのファイルサイズが 上 限 値 を 超 えている 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 14

24 3.4. 送 信 案 件 一 覧 情 報 取 得 リクエスト URI (1) 取 得 対 象 の 送 信 番 号 を 指 定 する 場 合 リクエスト URI HTTP メソッド GET (2) 取 得 対 象 期 間 を 指 定 する 場 合 リクエスト URI HTTP メソッド ;date={senddatefrom}-{senddateto} GET URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 SendNumber 英 数 字 取 得 対 象 の 送 信 番 号 SendDateFrom 数 字 取 得 対 象 期 間 の 開 始 日 [yyyymmdd] SendDateTo 数 字 取 得 対 象 期 間 の 終 了 日 [yyyymmdd] 取 得 対 象 期 間 を 指 定 する 場 合 開 始 日 と 終 了 日 の 両 方 を 指 定 する 必 要 があります 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 15

25 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 - 全 半 角 256 以 下 メッセージ ApplData データ SendNumber 1 - 英 数 字 18 取 得 要 求 した 送 信 番 号 SendDateFrom 1 - 数 字 8 取 得 要 求 した 取 得 対 象 期 間 の 開 始 日 SendDateTo 1 - 数 字 8 取 得 要 求 した 取 得 対 象 期 間 の 終 了 日 PackageApplyCount 1 数 字 3 以 下 取 得 結 果 件 数 エラー 時 は 0 PackageApply n 送 信 案 件 一 覧 情 報 該 当 データがない 場 合 はタグを 出 力 しない No 1 数 字 4 以 下 項 番 SendNumber 1 英 数 字 18 送 信 番 号 SendDate 1 数 字 14 送 信 日 時 [yyyymmddhhmmss] WorkStatus 1 全 角 4 以 下 処 理 状 態 NormalCount 1 数 字 4 以 下 処 理 件 数 AllCount 1 数 字 4 以 下 全 件 数 SupplementaryMessage 1 全 半 角 256 以 下 補 足 メッセージ ErrorCount 1 数 字 4 以 下 エラー 件 数 エラーファイル (エラ ErrorFile 1 半 角 1 以 上 ー 内 容 の html ファイルを Base64 でエンコードした 値 ) ApplyCount 1 数 字 4 以 下 申 請 案 件 一 覧 件 数 申 請 案 件 一 覧 情 報 Apply n 申 請 案 件 一 覧 件 数 が 0 の 場 合 はタグを 出 力 しな い No 1 英 数 字 4 以 下 項 番 ArriveID 1 英 数 字 18 到 達 番 号 MinistryName 1 全 角 12 以 下 府 省 名 ProcName 1 全 角 1024 以 下 手 続 名 ProcFolderName 1 英 数 字 32 以 下 手 続 フォルダ 名 ApplicantName 1 全 角 256 以 下 申 請 者 氏 名 CorporationtName 1 全 角 256 以 下 法 人 団 体 名 DepartmentName 1 全 角 256 以 下 部 門 名 Status 1 全 角 12 以 下 現 在 の 状 況 StatusDate 1 数 字 14 申 請 案 件 の 現 在 状 況 日 時 [yyyymmddhhmmss] PayStatus 1 全 角 6 以 下 納 付 状 況 PayWaitCount 1 数 字 4 以 下 納 付 待 ち 件 数 16

26 CorrectStatus 1 全 半 角 256 以 下 補 正 状 況 CommentCountNotRead 1 数 字 4 以 下 コメント 通 知 未 取 得 件 数 CommentCount 1 数 字 4 以 下 コメント 通 知 全 件 数 DocCountNotDownload 1 数 字 4 以 下 公 文 書 未 取 得 件 数 DocCount 1 数 字 4 以 下 公 文 書 全 件 数 送 信 案 件 一 覧 情 報 取 得 で 取 得 対 象 期 間 を 指 定 した 場 合 の 取 得 件 数 の 上 限 値 は 以 下 のとおりとなり ます この 上 限 値 を 超 える 場 合 は 取 得 対 象 期 間 を 変 更 するか 送 信 番 号 を 指 定 して 送 信 案 件 一 覧 情 報 を 取 得 してください 送 信 番 号 :100 件 到 達 番 号 :10,000 件 エラーファイル : 10 件 ( ) :エラーファイルの 出 力 例 2015 年 2 月 1 日 ~2 月 10 日 の 間 に 5 回 一 括 申 請 を 行 った 際 に 5 つの 一 括 申 請 中 2 つの 一 括 申 請 でエラーが 発 生 した 場 合 2015/02/01~2015/02/10 の 期 間 指 定 で 送 信 案 件 一 覧 情 報 取 得 を 行 った 際 に PackageApply タ グが 5 つ 出 力 され 内 2 つの PackageApply タグの ErrorFile タグにそれぞれ 1 件 ずつ( 合 計 2 件 )のエラーファイルが 返 却 されます なお エラーファイル 内 に 出 力 されるエラー 情 報 の 数 は 最 大 で 999 件 の 到 達 番 号 に 紐 づくエラー 情 報 が 出 力 され 一 括 申 請 を 行 った 際 に 含 んだ 申 請 データのチェック 結 果 に 応 じて 変 化 します HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 17

27 3.5. 申 請 案 件 一 覧 情 報 取 得 リクエスト URI リクエスト URI HTTP メソッド GET e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 SendNumber 英 数 字 取 得 対 象 の 送 信 番 号 送 信 パラメータ (1) ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) リクエスト 行 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ SendNumber 1 英 数 字 18 取 得 要 求 した 送 信 番 号 ErrorCount 1 数 字 4 以 下 エラー 件 数 エラーファイル (エラ ErrorFile 1 半 角 1 以 上 ー 内 容 の html ファイルを Base64 でエンコードした 値 ) ApplyCount 1 数 字 3 以 下 取 得 結 果 件 数 申 請 案 件 一 覧 情 報 Apply n 検 索 結 果 件 数 が 0 の 場 合 はタグを 出 力 しない No 1 数 字 4 以 下 項 番 ArriveID 1 英 数 字 18 到 達 番 号 MinistryName 1 全 角 12 以 下 府 省 名 ProcName 1 全 角 1024 以 下 手 続 名 ProcFolderName 1 英 数 字 32 以 下 手 続 フォルダ 名 ApplicantName 1 全 角 256 以 下 申 請 者 氏 名 CorporationtName 1 全 角 256 以 下 法 人 団 体 名 18

28 DepartmentName 1 全 角 256 以 下 部 門 名 Status 1 全 角 12 以 下 現 在 の 状 況 StatusDate 1 数 字 14 申 請 案 件 の 現 在 状 況 日 時 [yyyymmddhhmmss] PayStatus 1 全 角 6 以 下 納 付 状 況 PayWaitCount 1 数 字 4 以 下 納 付 待 ち 件 数 CorrectStatus 1 全 半 角 256 以 下 補 正 状 況 CommentCountNotRead 1 数 字 4 以 下 コメント 通 知 未 取 得 件 数 CommentCount 1 数 字 4 以 下 コメント 通 知 全 件 数 DocCountNotDownload 1 数 字 4 以 下 公 文 書 未 取 得 件 数 DocCount 1 数 字 4 以 下 公 文 書 全 件 数 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 19

29 3.6. 状 況 照 会 リクエスト URI リクエスト URI HTTP メソッド GET URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 ArriveID 英 数 字 取 得 対 象 の 到 達 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) リクエスト 行 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 取 得 要 求 した 到 達 番 号 ProcName 1 全 角 1024 以 下 手 続 名 エラー 時 は 空 AmendMessage 1 全 半 角 256 以 下 補 正 状 況 メッセージ エラー 時 は 空 CommentMessage 1 全 半 角 256 以 下 コメント 状 況 メッセージ エラー 時 は 空 DocumentMessage 1 全 半 角 256 以 下 公 文 書 状 況 メッセージ エラー 時 は 空 PayMessage 1 全 半 角 256 以 下 納 付 状 況 メッセージ エラー 時 は 空 Status 1 全 半 角 12 以 下 申 請 状 況 エラー 時 は 空 ArriveDate 1 数 字 14 到 達 日 時 [yyyymmddhhmmss] エラー 時 は 空 20

30 ExamStartDate 1 数 字 14 審 査 開 始 日 時 [yyyymmddhhmmss] エラー 時 は 空 ExamEndDate 1 数 字 14 審 査 終 了 日 時 [yyyymmddhhmmss] エラー 時 は 空 ProcEndDate 1 数 字 14 手 続 終 了 日 時 [yyyymmddhhmmss] WithdrawFlag 1 数 字 1 取 下 げ 可 能 フラグ ( 可 :1/ 不 可 :0) エラー 時 は 空 WithdrawType 1 数 字 1 取 下 げ 方 法 ( 取 下 げなし:0/ 取 下 げ 依 頼 :1/ 取 下 げ 申 請 :2) エラー 時 は 空 ReintroductionFlag 1 数 字 1 補 正 申 請 可 能 フラグ ( 可 :1/ 不 可 :0) エラー 時 は 空 ApplyHistory n 申 請 案 件 履 歴 情 報 エラー 時 は 出 力 しない ApplyHistorySubID 1 数 字 18 履 歴 通 番 RegDate 1 数 字 14 登 録 日 時 [yyyymmddhhmmss] OperatorType 1 全 角 4 以 下 処 理 区 分 申 請 者 からの 申 請 : 送 信 府 省 側 で 処 理 : 受 信 e-gov 電 子 申 請 システム 側 の 処 理 : システム ProcessType 1 全 角 13 以 下 処 理 履 歴 ApplyStatus 1 全 半 角 12 以 下 申 請 状 況 PayNumber 1 数 字 16 納 付 番 号 PayStatus 1 全 角 6 以 下 納 付 状 況 TotalFee 1 数 字 11 以 下 手 数 料 額 PayExpiredDate 1 数 字 8 納 付 期 限 [yyyymmdd] HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 21

31 3.7. 取 下 げ リクエスト URI リクエスト URI HTTP メソッド POST URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ ArriveID 1 英 数 字 18 取 下 げ 対 象 の 到 達 番 号 Upload ZIP 形 式 にした 取 下 げす FileData 1 半 角 1 以 上 る 申 請 データを Base64 で エンコードしたデータ( 1) 1. 申 請 データの 構 造 及 び 形 式 は 申 請 データ 仕 様 書 共 通 データ 仕 様 書 を 参 照 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 到 達 番 号 ProcName 1 全 角 1024 以 下 手 続 名 エラー 時 は 空 ArriveDate 1 数 字 14 取 下 げ 依 頼 日 時 [yyyymmddhhmmss] エラー 時 は 空 NewArriveID 1 英 数 字 18 取 下 げ 申 請 に 係 わる 到 達 22

32 番 号 取 下 げ 方 法 が 取 下 げ 依 頼 又 はエラーの 場 合 は 空 Error n エラー 内 容 エラーがない 場 合 は 出 力 しない FileName 1 1 全 半 角 256 以 下 エラーとなった 構 成 管 理 XML 様 式 名 または 添 付 書 類 名 Type 1 1 全 角 256 以 下 エラー 種 別 (エラーとなっ た 形 式 チェックの 種 別 ) Content 1 1 全 半 角 256 以 下 エラー 内 容 ArriveResult 1 1 全 角 3 以 下 到 達 結 果 到 達 または エラー ApplyType 1 1 全 角 3 以 下 申 請 区 分 取 下 げ 取 下 げ 依 頼 の 場 合 は 空 MinistryName 1 1 全 角 12 以 下 受 付 府 省 ReceptionDesk 1 1 全 角 256 以 下 受 付 窓 口 ( 構 成 管 理 情 報 の 提 出 先 名 称 ) ApplicantName 1 1 全 角 256 以 下 申 請 者 名 ApplyForm n 申 請 様 式 一 覧 FormName 1 1 全 角 128 以 下 様 式 名 ApplyFile n ファイル 一 覧 FileName 1 1 全 半 角 256 以 下 ファイル 名 OrgDist n 別 送 情 報 No 1 1 数 字 4 以 下 項 番 DocName 1 1 全 半 角 256 以 下 別 送 書 類 名 称 OrgDistFileSend 1 1 全 半 角 256 以 下 別 送 書 類 送 り 先 情 報 ApplyPay n 手 数 料 情 報 No 1 1 数 字 4 以 下 項 番 PayNumber 1 1 英 数 字 16 納 付 番 号 ConfirmNumber 1 1 数 字 6 確 認 番 号 FacilityNumber 1 1 英 数 字 5 収 納 機 関 番 号 PayNameKana 1 1 全 角 24 以 下 手 続 名 TotalFee 1 1 数 字 11 以 下 払 込 金 額 PayExpired 1 1 数 字 8 払 込 期 限 [yyyymmdd] 1. 取 下 げ 申 請 の 場 合 のみ 設 定 取 下 げ 依 頼 時 空 が 設 定 される HTTP レスポンスコード 返 却 値 内 容 202 Accepted 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 413 Request Entity Too Large アップロードファイルのファイルサイズが 上 限 値 を 超 えている 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 23

33 3.8. 補 正 通 知 一 覧 取 得 リクエスト URI リクエスト URI HTTP メソッド GET e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 ArriveID 英 数 字 取 得 対 象 の 到 達 番 号 送 信 パラメータ (1) ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) リクエスト 行 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 取 得 要 求 した 到 達 番 号 ProcName 1 全 角 1024 以 下 手 続 名 CorrectType 1 数 字 1 補 正 種 別 ( 部 分 補 正 :0/ 再 提 出 :1) AmendDocType 1 数 字 1 部 分 補 正 種 別 補 正 種 別 が 1 の 場 合 は 空 補 正 種 別 が 0 の 場 合 は 以 下 のとおり 基 本 情 報 申 請 書 :1 添 付 別 送 書 類 :2 基 本 情 報 申 請 書 と 添 付 書 類 :3 任 意 :4 AmendDoc n 添 付 書 類 情 報 部 分 補 正 種 別 が 1 と 4 と 空 の 場 合 は タグを 出 力 しな い 24

34 添 付 種 別 添 付 または 別 送 DocType 1 - 全 半 角 256 以 下 補 正 ( 部 分 補 正 )を 行 う 場 合 申 請 データの 構 成 管 理 XML 内 に 存 在 する 添 付 種 別 のタグにこの 値 を 設 定 する 添 付 書 類 名 称 補 正 ( 部 分 補 正 )を 行 う 場 DocName 1 - 全 半 角 256 以 下 合 申 請 データの 構 成 管 理 XML 内 に 存 在 する 添 付 書 類 名 称 のタグにこの 値 を 設 定 する 補 正 一 覧 情 報 Official n 補 正 情 報 がない 又 はエ ラーの 場 合 は 出 力 しない NoticeSubID 1 数 字 3 以 下 通 知 通 番 CorrectRequestedDate 1 数 字 14 補 正 要 求 日 時 [yyyymmddhhmmss] CorrectExpiredDate 1 数 字 8 補 正 期 限 日 [yyyymmdd] CorrectCompletedDate 1 数 字 14 補 正 完 了 日 時 [yyyymmddhhmmss] DocTitle 1 全 半 角 256 以 下 件 名 ZIP 形 式 にした 通 知 デー FileData 1 半 角 1 以 上 タファイルを Base64 でエ ンコードしたデータ File n - - 補 正 通 知 ファイル 情 報 項 目 FileName 1 全 半 角 256 以 下 通 知 データファイル 名 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 25

35 3.9. 補 正 ( 再 提 出 ) リクエスト URI リクエスト URI HTTP メソッド POST e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ ArriveID 1 英 数 字 18 補 正 ( 再 提 出 )する 到 達 番 号 Upload アップロードファイル 項 目 ZIP 形 式 にした 補 正 ( 再 提 FileData 1 半 角 1 以 上 出 )する 申 請 データを Base64 でエンコードした データ( 1) 1. 申 請 データの 構 造 及 び 形 式 は 申 請 データ 仕 様 書 共 通 データ 仕 様 書 を 参 照 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 補 正 ( 再 提 出 ) 要 求 した 到 達 番 号 ProcName 1 全 角 1024 以 下 手 続 名 エラー 時 は 空 ArriveDate 1 数 字 14 到 達 日 時 26

36 [yyyymmddhhmmss] エラー 時 は 空 NewArriveID 1 英 数 字 18 新 たに 採 番 した 到 達 番 号 エラー 時 は 空 Error n エラー 内 容 エラーがない 場 合 は 出 力 しない FileName 1 全 半 角 256 以 下 エラーとなった 構 成 管 理 XML 様 式 名 または 添 付 書 類 名 Type 1 全 角 256 以 下 エラー 種 別 (エラーとなっ た 形 式 チェックの 種 別 ) Content 1 全 半 角 256 以 下 エラー 内 容 ArriveResult 1 全 角 3 以 下 到 達 結 果 到 達 または エラー ApplyType 1 全 角 3 以 下 申 請 区 分 補 正 MinistryName 1 全 角 12 以 下 受 付 府 省 ReceptionDesk 1 全 角 256 以 下 受 付 窓 口 ( 構 成 管 理 情 報 の 提 出 先 名 称 ) ApplicantName 1 全 角 256 以 下 申 請 者 名 ApplyForm n 申 請 様 式 一 覧 FormName 1 全 角 128 以 下 様 式 名 ApplyFile n ファイル 一 覧 FileName 1 全 半 角 256 以 下 ファイル 名 OrgDist n 別 送 情 報 No 1 数 字 4 以 下 項 番 DocName 1 全 半 角 256 以 下 別 送 書 類 名 称 OrgDistFileSend 1 全 半 角 256 以 下 別 送 書 類 送 り 先 情 報 ApplyPay n 手 数 料 情 報 No 1 数 字 4 以 下 項 番 PayNumber 1 英 数 字 16 納 付 番 号 ConfirmNumber 1 数 字 6 確 認 番 号 FacilityNumber 1 英 数 字 5 収 納 機 関 番 号 PayNameKana 1 全 角 24 以 下 手 続 名 TotalFee 1 数 字 11 以 下 払 込 金 額 PayExpired 1 数 字 8 払 込 期 限 [yyyymmdd] HTTP レスポンスコード 返 却 値 内 容 202 Accepted 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 413 Request Entity Too Large アップロードしたファイルのファイルサイズが 上 限 値 を 超 えている 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 27

37 3.10. 補 正 ( 部 分 補 正 ) リクエスト URI リクエスト URI HTTP メソッド POST e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ ArriveID 1 英 数 字 18 補 正 ( 部 分 補 正 )する 到 達 番 号 Target アップロードファイル 項 目 基 本 情 報 申 請 書 補 正 フラ BasicFormFlag 1 英 数 字 1 グ ( 補 正 有 :1/ 補 正 無 :0) AttachedFlag 1 英 数 字 1 添 付 書 類 補 正 フラグ ( 補 正 有 :1/ 補 正 無 :0) Upload アップロードファイル 項 目 ZIP 形 式 にした 補 正 ( 部 分 FileData 1 半 角 1 以 上 補 正 )する 申 請 データを Base64 でエンコードした データ( 1) 1. 申 請 データの 構 造 及 び 形 式 は 申 請 データ 仕 様 書 共 通 データ 仕 様 書 を 参 照 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) 28

38 Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 補 正 ( 部 分 補 正 ) 要 求 した 到 達 番 号 ProcName 1 全 角 1024 以 下 手 続 名 エラー 時 は 空 ArriveDate 1 数 字 14 到 達 日 時 [yyyymmddhhmmss] エラー 時 は 空 NewArriveID 1 英 数 字 18 空 ( 部 分 補 正 時 は 必 ず 空 となる ) Error n エラー 内 容 エラーがない 場 合 は 出 力 しない FileName 1 全 半 角 256 以 下 エラーとなった 構 成 管 理 XML 様 式 名 または 添 付 書 類 名 Type 1 全 角 256 以 下 エラー 種 別 (エラーとなっ た 形 式 チェックの 種 別 ) Content 1 全 半 角 256 以 下 エラー 内 容 ArriveResult 1 全 角 3 以 下 到 達 結 果 到 達 または エラー ApplyType 1 全 角 3 以 下 申 請 区 分 補 正 MinistryName 1 全 角 12 以 下 受 付 府 省 ReceptionDesk 1 全 角 256 以 下 受 付 窓 口 ( 構 成 管 理 情 報 の 提 出 先 名 称 ) ApplicantName 1 全 角 256 以 下 申 請 者 名 ApplyForm n 申 請 様 式 一 覧 FormName 1 全 角 128 以 下 様 式 名 ApplyFile n ファイル 一 覧 FileName 1 全 半 角 256 以 下 ファイル 名 OrgDist n 別 送 情 報 No 1 数 字 4 以 下 項 番 DocName 1 全 半 角 256 以 下 別 送 書 類 名 称 OrgDistFileSend 1 全 半 角 256 以 下 別 送 書 類 送 り 先 情 報 ApplyPay n 手 数 料 情 報 No 1 数 字 4 以 下 項 番 PayNumber 1 英 数 字 16 納 付 番 号 ConfirmNumber 1 数 字 6 確 認 番 号 FacilityNumber 1 英 数 字 5 収 納 機 関 番 号 PayNameKana 1 全 角 24 以 下 手 続 名 TotalFee 1 数 字 11 以 下 払 込 金 額 PayExpired 1 数 字 8 払 込 期 限 [yyyymmdd] HTTP レスポンスコード 返 却 値 内 容 202 Accepted 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 413 Request Entity Too Large アップロードしたファイルのファイルサイズが 上 限 値 を 超 えている 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 29

39 3.11. 補 正 ( 補 正 申 請 ) リクエスト URI リクエスト URI HTTP メソッド POST e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ ArriveID 1 英 数 字 18 補 正 ( 補 正 申 請 )する 到 達 番 号 Upload アップロードファイル 項 目 ZIP 形 式 にした 補 正 ( 補 正 FileData 1 半 角 1 以 上 申 請 )する 申 請 データを Base64 でエンコードした データ( 1) 1. 申 請 データの 構 造 及 び 形 式 は 申 請 データ 仕 様 書 共 通 データ 仕 様 書 を 参 照 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ 補 正 ( 補 正 申 請 ) 要 求 した ArriveID 1 英 数 字 18 到 達 番 号 エラー 時 は 空 ProcName 1 全 角 1024 以 下 手 続 名 エラー 時 は 空 30

40 ArriveDate 1 数 字 14 到 達 日 時 [yyyymmddhhmmss] エラー 時 は 空 NewArriveID 1 英 数 字 18 新 たに 採 番 した 到 達 番 号 エラー 時 は 空 Error n エラー 内 容 エラーがない 場 合 は 出 力 しない FileName 1 全 半 角 256 以 下 エラーとなった 構 成 管 理 XML 様 式 名 または 添 付 書 類 名 Type 1 全 角 256 以 下 エラー 種 別 (エラーとなっ た 形 式 チェックの 種 別 ) Content 1 全 半 角 256 以 下 エラー 内 容 ArriveResult 1 全 角 3 以 下 到 達 結 果 到 達 または エラー ApplyType 1 全 角 3 以 下 申 請 区 分 補 正 MinistryName 1 全 角 12 以 下 受 付 府 省 ReceptionDesk 1 全 角 256 以 下 受 付 窓 口 ( 構 成 管 理 情 報 の 提 出 先 名 称 ) ApplicantName 1 全 角 256 以 下 申 請 者 名 ApplyForm n 申 請 様 式 一 覧 FormName 1 全 角 128 以 下 様 式 名 ApplyFile n ファイル 一 覧 FileName 1 全 半 角 256 以 下 ファイル 名 OrgDist n 別 送 情 報 No 1 数 字 4 以 下 項 番 DocName 1 全 半 角 256 以 下 別 送 書 類 名 称 OrgDistFileSend 1 全 半 角 256 以 下 別 送 書 類 送 り 先 情 報 ApplyPay n 手 数 料 情 報 No 1 数 字 4 以 下 項 番 PayNumber 1 英 数 字 16 納 付 番 号 ConfirmNumber 1 数 字 6 確 認 番 号 FacilityNumber 1 英 数 字 5 収 納 機 関 番 号 PayNameKana 1 全 角 24 以 下 手 続 名 TotalFee 1 数 字 11 以 下 払 込 金 額 PayExpired 1 数 字 8 払 込 期 限 [yyyymmdd] HTTP レスポンスコード 返 却 値 内 容 202 Accepted 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 413 Request Entity Too Large アップロードしたファイルのファイルサイズが 上 限 値 を 超 えている 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 31

41 3.12. 公 文 書 コメント 一 覧 取 得 リクエスト URI リクエスト URI HTTP メソッド GET e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 ArriveID 英 数 字 取 得 対 象 の 到 達 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) リクエスト 行 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 到 達 番 号 ProcName 1 全 角 1024 以 下 手 続 名 エラー 時 は 空 Official n 公 文 書 一 覧 情 報 公 文 書 情 報 がない 場 合 は 出 力 しない NoticeSubID 1 数 字 3 以 下 通 知 通 番 AllowedDate 1 数 字 14 発 行 日 時 [yyyymmddhhmmss] DocTitle 1 全 半 角 256 以 下 件 名 File n - - 公 文 書 ファイル 情 報 FileName 1 全 半 角 256 以 下 公 文 書 ファイル 名 DownloadExpiredDate 1 数 字 14 取 得 期 限 [yyyymmddhhmmss] DownloadDate 1 数 字 14 取 得 日 時 [yyyymmddhhmmss] Sign 1 全 角 2 以 下 署 名 有 無 32

42 ExpiredDateFlag 1 英 数 字 1 有 効 期 限 フラグ ( 期 限 内 :0/ 期 限 切 れ:1) Comment n - - コメント 通 知 一 覧 情 報 項 目 コメント 通 知 情 報 がな い 場 合 は 出 力 しない NoticeSubID 1 数 字 3 以 下 通 知 通 番 IssueDate 1 数 字 14 発 行 日 時 [yyyymmddhhmmss] DocTitle 1 全 半 角 256 以 下 件 名 File n - - 添 付 ファイル 情 報 FileName 1 全 半 角 256 以 下 添 付 ファイル 名 Reading 1 全 角 2 以 下 開 封 状 況 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 33

43 3.13. 公 文 書 取 得 リクエスト URI リクエスト URI HTTP メソッド /{ArriveID}/{NoticeSubID} GET e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 ArriveID 英 数 字 取 得 対 象 の 到 達 番 号 NoticeSubID 数 字 取 得 対 象 の 通 知 通 番 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) リクエスト 行 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 取 得 要 求 した 到 達 番 号 NoticeSubID 1 数 字 3 以 下 取 得 要 求 した 通 知 通 番 Download ダウンロード エラー 時 は 出 力 しない ZIP 形 式 にした 公 文 書 デ FileData 1 半 角 1 以 上 ータを Base64 でエンコー ドしたデータ HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 34

44 3.14. 公 文 書 取 得 完 了 リクエスト URI リクエスト URI HTTP メソッド PUT e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ ArriveID 1 英 数 字 18 取 得 完 了 する 到 達 番 号 NoticeSubID 1 数 字 3 以 下 取 得 完 了 する 通 知 通 番 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 取 得 完 了 要 求 した 到 達 番 号 NoticeSubID 1 数 字 3 以 下 取 得 完 了 要 求 した 通 知 番 号 ProcName 1 全 角 1024 以 下 手 続 名 エラー 時 は 空 DocTitle 1 全 半 角 256 以 下 件 名 エラー 時 は 空 DownloadDate 1 数 字 14 取 得 日 時 [yyyymmddhhmmss] エラー 時 は 空 File n 公 文 書 情 報 35

45 エラー 時 は 出 力 しない FileName 1 全 半 角 256 以 下 公 文 書 ファイル 名 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 36

46 3.15. 公 文 書 署 名 検 証 リクエスト URI リクエスト URI HTTP メソッド e-gov 電 子 申 請 システム POST URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ ArriveID 1 英 数 字 18 署 名 検 証 する 到 達 番 号 Upload アップロード 公 文 書 ファイル 名 FileName 1 全 半 角 256 以 下 (FileData の に 指 定 する ZIP ファイル 名 )( 1) FileData 1 半 角 1 以 上 公 文 書 取 得 API で 取 得 し た ZIP 形 式 の 公 文 書 デー タを Base64 でエンコード したデータ( 2) SigVerificationXML FileName 1 全 半 角 256 以 下 署 名 検 証 XML ファイル 名 ( 3) 1. FileData にて 指 定 したデータの ZIP ファイル 名 を 任 意 のファイル 名 で 指 定 してください 2. 公 文 書 取 得 API で 取 得 した ZIP 形 式 の 公 文 書 データは 鑑 文 書 と 任 意 の 数 の 添 付 ファイルで 構 成 さ れています( 添 付 ファイルが 含 まれない 場 合 もあります) この 公 文 書 データ 一 式 をそのまま Base64 でエンコードしたデータを 指 定 してください 3. 公 文 書 取 得 API で 取 得 した 公 文 書 ZIP ファイル 内 に 含 まれるファイルのうち 鑑 文 書 (XML ファイ ル)のファイル 名 を 指 定 します 鑑 文 書 は 添 付 ファイルを 含 む 公 文 書 全 てを 対 象 とした 官 職 署 名 (XML 署 名 )を 付 与 できる XML ファイルです( 官 職 署 名 がない 場 合 もあります) このため 公 文 書 署 名 検 証 では 官 職 署 名 を 含 む 鑑 文 書 の XML ファイル 名 を 指 定 する 仕 様 としています 37

47 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 署 名 検 証 要 求 した 到 達 番 号 ErrorCount 1 数 字 3 以 下 エラー 件 数 エラー 内 容 Error n 署 名 検 証 エラーまたは 証 明 書 検 証 エラーとなっ た 場 合 に 出 力 する FileName 1 全 半 角 256 以 下 エラーファイル 名 Content 1 全 半 角 256 以 下 エラー 内 容 DocumentFileName 1 全 半 角 256 以 下 鑑 文 書 AttachedFileName 1 全 半 角 256 以 下 添 付 ファイル VerifyResult n 検 証 結 果 Official n - - 官 職 証 明 書 検 証 結 果 検 証 結 果 ValidationResult 1 全 半 角 256 以 下 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する CertificateResult 1 全 半 角 256 以 下 証 明 書 の 検 証 結 果 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する CertificateCount 1 全 半 角 256 以 下 確 認 した 証 明 書 の 数 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する Publisher 1 全 半 角 256 以 下 発 行 者 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する Owner 1 全 半 角 256 以 下 所 有 者 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する PublisherDN 1 全 半 角 256 以 下 発 行 者 [DN] 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する OwnerDN 1 全 半 角 256 以 下 所 有 者 [DN] 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する SerialNumber 1 全 半 角 256 以 下 シリアルナンバー 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する TermValidity 1 全 半 角 44 以 下 有 効 期 間 官 職 証 明 書 検 証 が 行 わ れた 場 合 に 出 力 する Government n 行 政 機 関 証 明 書 検 証 結 果 38

48 PublisherDN 1 全 半 角 256 以 下 OwnerDN 1 全 半 角 256 以 下 SerialNumber 1 全 半 角 256 以 下 TermValidity 1 全 半 角 44 以 下 発 行 者 [DN] 行 政 機 関 証 明 書 検 証 が 行 われた 場 合 に 出 力 する 所 有 者 [DN] 行 政 機 関 証 明 書 検 証 が 行 われた 場 合 に 出 力 する シリアルナンバー 行 政 機 関 証 明 書 検 証 が 行 われた 場 合 に 出 力 する 有 効 期 間 行 政 機 関 証 明 書 検 証 が 行 われた 場 合 に 出 力 する HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 39

49 3.16. コメント 通 知 取 得 リクエスト URI リクエスト URI HTTP メソッド /{ArriveID}/{NoticeSubID} GET e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 ArriveID 英 数 字 取 得 対 象 の 到 達 番 号 NoticeSubID 数 字 取 得 対 象 の 通 知 通 番 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) リクエスト 行 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 取 得 要 求 した 到 達 番 号 NoticeSubID 1 数 字 3 以 下 取 得 要 求 した 通 知 通 番 Download ダウンロード エラー 時 は 出 力 しない ZIP 形 式 にしたコメント FileData 1 半 角 1 以 上 通 知 データを Base64 でエ ンコードしたデータ HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 40

50 3.17. コメント 通 知 取 得 完 了 リクエスト URI リクエスト URI HTTP メソッド PUT e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ ArriveID 1 英 数 字 18 取 得 完 了 にする 到 達 番 号 NoticeSubID 1 数 字 3 以 下 取 得 完 了 にする 通 知 通 番 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 取 得 完 了 要 求 した 到 達 番 号 NoticeSubID 1 数 字 3 以 下 取 得 完 了 要 求 した 通 知 番 号 ProcName 1 全 角 1024 以 下 手 続 名 エラー 時 は 空 DocTitle 1 全 半 角 256 以 下 件 名 エラー 時 は 空 DownloadDate 1 数 字 14 取 得 日 時 [yyyymmddhhmmss] エラー 時 は 空 File n コメント 通 知 情 報 41

51 エラー 時 は 出 力 しない FileName 1 全 半 角 256 以 下 コメント 通 知 ファイル 名 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 42

52 3.18. 電 子 納 付 対 応 金 融 機 関 一 覧 取 得 リクエスト URI リクエスト URI HTTP メソッド GET URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) リクエスト 行 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ TrustBank 銀 行 信 託 銀 行 一 覧 エラー 時 は 出 力 しない Initial n 頭 文 字 情 報 (attribute)name 1 全 半 角 1 頭 文 字 Bank n 金 融 機 関 情 報 FinancialName 1 全 半 角 256 以 下 金 融 機 関 名 称 ServiceName 1 全 角 256 以 下 ネットバンク 商 品 名 Url 1 半 角 256 以 下 リンク URL ShinkinBank 信 用 金 庫 情 報 エラー 時 は 出 力 しない Bank n 金 融 機 関 情 報 FinancialName 1 全 半 角 256 以 下 金 融 機 関 名 称 Url 1 半 角 256 以 下 リンク URL CreditUnion 信 用 組 合 情 報 エラー 時 は 出 力 しない Bank n 金 融 機 関 情 報 FinancialName 1 全 半 角 256 以 下 金 融 機 関 名 称 Url 1 半 角 256 以 下 リンク URL 43

53 NorinchukinBank 農 林 中 央 金 庫 情 報 エラー 時 は 出 力 しない Bank n 金 融 機 関 情 報 FinancialName 1 全 半 角 256 以 下 金 融 機 関 名 称 Url 1 半 角 256 以 下 リンク URL LabourBank 労 働 金 庫 情 報 エラー 時 は 出 力 しない Bank n 金 融 機 関 情 報 FinancialName 1 全 半 角 256 以 下 金 融 機 関 名 称 Url 1 半 角 256 以 下 リンク URL 金 融 機 関 種 別 一 覧 情 報 日 FinancialTypeListDate 1 数 字 8 時 [yyyymmdd] エラー 時 は 空 上 記 XML 内 の(attribute)は 属 性 を 指 します (attribute)という ではありません HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 44

54 3.19. 納 付 情 報 一 覧 取 得 リクエスト URI リクエスト URI HTTP メソッド e-gov 電 子 申 請 システム GET URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 ArriveID 英 数 字 取 得 対 象 の 到 達 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-accesskey 英 数 字 利 用 者 認 証 で 取 得 したアクセスキー x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) リクエスト 行 なし 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ ArriveID 1 英 数 字 18 取 得 要 求 した 到 達 番 号 ProcName 1 全 角 1024 以 下 手 続 名 納 付 情 報 一 覧 ApplyPay n 納 付 情 報 が 存 在 しない 又 はエラー 時 は 出 力 しな い PayNumber 1 英 数 字 16 納 付 番 号 ConfirmNumber 1 数 字 6 確 認 番 号 FacilityNumber 1 英 数 字 5 収 納 機 関 番 号 PayNameKana 1 全 角 24 以 下 手 続 名 (カナ) PayExpiredDate 1 数 字 8 納 付 期 限 [yyyymmdd] TotalFee 1 数 字 11 以 下 納 付 金 額 PayStatus 1 全 角 6 以 下 納 付 状 況 PayDate 1 数 字 8 納 付 日 [yyyymmdd] PayMemo 1 全 半 角 1024 以 下 通 信 欄 PayFlag 1 英 数 字 1 納 付 フラグ ( 電 子 納 付 可 :1/ 電 子 納 付 45

55 不 可 :0) HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 46

56 3.20. 電 子 納 付 金 融 機 関 サイト 表 示 リクエスト URI リクエスト URI HTTP メソッド POST WEB ブラウザからの 起 動 を 前 提 e-gov 電 子 申 請 システム URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ 本 API は ブラウザからのアクセスを 想 定 しているため HTTP ヘッダ 部 に 特 有 のヘッ ダ 情 報 は 付 与 しません (1) HTTP ヘッダ 部 ヘッダなし (2) HTTP ボディ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 SoftwareID 1 英 数 字 12 ソフトウェア ID の 値 AccessKey 英 数 字 利 用 者 認 証 で 取 得 したア 以 下 クセスキー ArriveID 1 英 数 字 18 到 達 番 号 PayNumber 1 数 字 16 納 付 番 号 BankName 1 全 半 角 256 以 下 金 融 機 関 名 称 ProcID 1 数 字 16 手 続 識 別 子 応 答 結 果 HTML 本 API は 指 定 された 電 子 納 付 金 融 機 関 サイトをリダイレクト 表 示 します 正 常 終 了 時 は 処 理 結 果 XML の 代 わりに 対 象 金 融 機 関 サイトを 表 示 します エラーが 発 生 した 場 合 以 下 の 内 容 を 含 む HTML 画 面 を 返 却 します 必 須 文 字 種 返 却 内 容 メッセージ 全 半 角 エラーメッセージ 到 達 番 号 英 数 字 要 求 した 到 達 番 号 納 付 番 号 数 字 要 求 した 納 付 番 号 47

57 3.21. 証 明 書 識 別 情 報 追 加 リクエスト URI リクエスト URI HTTP メソッド e-gov 電 子 申 請 システム POST URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ (attribute)id 1 英 数 字 8 ApplData UserID 1 英 数 字 12 以 下 利 用 者 ID AddX509Certificate 1 英 数 字 1 以 上 新 規 登 録 する 公 開 鍵 証 明 書 Signature 署 名 情 報 (attribute)xmlns 1 半 角 1 以 上 XMLSignature の 名 前 空 間 (attribute)id 1 半 角 14 署 名 付 与 した 日 時 [yyyymmddhhmmss] SignedInfo データ Canonicalization Method データ SignedInfo Reference に (attribute) 1 半 角 1 以 上 対 する 正 規 化 に 使 用 する Algorithm アルゴリズム SignatureMethod データ (attribute) 1 半 角 1 以 上 SignedInfo の 署 名 値 計 算 Algorithm に 使 用 するアルゴリズム Reference データ (attribute) URI 1 半 角 1 以 上 XML の URI Transforms データ Transform データ (attribute) Algorithm 1 半 角 1 以 上 Reference 対 象 に 対 する 正 規 化 に 使 用 するアルゴ リズム DigestMethod データ Reference 対 象 に 対 する (attribute) 1 半 角 1 以 上 ダイジェスト 計 算 に 使 用 Algorithm するアルゴリズム DigestValue 1 半 角 1 以 上 構 成 定 義 の 計 算 対 象 48

58 SignatureValue 1 半 角 1 以 上 SignatureMethod で 指 定 したアルゴリズムで 生 成 された 署 名 値 ( 1) KeyInfo データ X509Data データ 署 名 付 与 に 使 用 した 証 明 X509Certificate 1 半 角 1 以 上 書 の Base64 エンコード 値 ( 1) 上 記 XML 内 の(attribute)は 属 性 を 指 します (attribute)という ではありません Signature タグの 詳 細 ついては 9.2.HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 構 成 を 参 照 してください 1. 署 名 情 報 の SignatureValue X509Certificate には 登 録 済 みの 有 効 期 限 が 切 れていない 公 開 鍵 証 明 書 の 情 報 を 指 定 します 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ UserID 1 英 数 字 12 以 下 証 明 書 識 別 情 報 を 登 録 し た 利 用 者 ID LastAuthenticationDate 1 - 英 数 字 14 前 回 認 証 が 成 功 した 日 時 [yyyymmddhhmmss] エラー 時 は 空 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 49

59 3.22. 証 明 書 識 別 情 報 更 新 リクエスト URI リクエスト URI HTTP メソッド e-gov 電 子 申 請 システム POST URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ (attribute)id 1 英 数 字 8 ApplData UserID 1 英 数 字 12 以 下 利 用 者 ID X509Certificate 1 英 数 字 1 以 上 有 効 期 限 が 切 れた 登 録 済 の 公 開 鍵 証 明 書 Signature 署 名 情 報 (attribute)xmlns 1 半 角 1 以 上 XMLSignature の 名 前 空 間 (attribute)id 1 半 角 14 署 名 付 与 した 日 時 [yyyymmddhhmmss] SignedInfo データ CanonicalizationMethod データ SignedInfo Reference に (attribute) 1 半 角 1 以 上 対 する 正 規 化 に 使 用 する Algorithm アルゴリズム SignatureMethod データ (attribute) Algorithm 1 半 角 1 以 上 SignedInfo の 署 名 値 計 算 に 使 用 するアルゴリズム Reference データ (attribute) URI 1 半 角 1 以 上 XML の URI Transforms データ Transform データ (attribute) Algorithm 1 半 角 1 以 上 DigestMethod データ (attribute) Algorithm 1 半 角 1 以 上 Reference 対 象 に 対 する 正 規 化 に 使 用 するアルゴ リズム Reference 対 象 に 対 する ダイジェスト 計 算 に 使 用 するアルゴリズム DigestValue 1 半 角 1 以 上 構 成 定 義 の 計 算 対 象 SignatureValue 1 半 角 1 以 上 SignatureMethod で 指 定 50

60 したアルゴリズムで 生 成 された 署 名 値 ( 1) KeyInfo データ X509Data データ 署 名 付 与 に 使 用 した 証 明 X509Certificate 1 半 角 1 以 上 書 の Base64 エンコード 値 ( 1) 上 記 XML 内 の(attribute)は 属 性 を 指 します (attribute)という ではありません Signature タグの 詳 細 ついては 9.2.HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 構 成 を 参 照 してください 1. 署 名 情 報 の SignatureValue X509Certificate には 新 規 追 加 する 有 効 期 限 が 切 れていない 公 開 鍵 証 明 書 の 情 報 を 設 定 します 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ UserID 1 英 数 字 12 以 下 証 明 書 識 別 情 報 を 更 新 し た 利 用 者 ID LastAuthenticationDate 1 - 英 数 字 14 前 回 認 証 が 成 功 した 日 時 [yyyymmddhhmmss] エラー 時 は 空 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 51

61 3.23. 証 明 書 識 別 情 報 削 除 リクエスト URI リクエスト URI HTTP メソッド e-gov 電 子 申 請 システム POST URI パラメータ 必 須 文 字 種 設 定 内 容 設 定 可 能 値 Version 英 数 字 利 用 する のバージョン 番 号 送 信 パラメータ (1) HTTP ヘッダ 部 必 須 文 字 種 設 定 内 容 設 定 可 能 値 x-egovapi-softwareid 英 数 字 ソフトウェア ID の 値 (2) HTTP ボディ 部 XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 設 定 内 容 設 定 可 能 値 DataRoot ApplData データ (attribute)id 1 英 数 字 8 ApplData UserID 1 英 数 字 12 以 下 利 用 者 ID DelX509Certificate 1 英 数 字 1 以 上 削 除 する 公 開 鍵 証 明 書 ( 2) Signature 署 名 情 報 (attribute)xmlns 1 半 角 1 以 上 XMLSignature の 名 前 空 間 (attribute)id 1 半 角 14 署 名 付 与 した 日 時 [yyyymmddhhmmss] SignedInfo データ Canonicalization Method データ SignedInfo Reference に (attribute) 1 半 角 1 以 上 対 する 正 規 化 に 使 用 する Algorithm アルゴリズム SignatureMethod データ (attribute) 1 半 角 1 以 上 SignedInfo の 署 名 値 計 算 Algorithm に 使 用 するアルゴリズム Reference データ (attribute) URI 1 半 角 1 以 上 XML の URI Transforms データ Transform データ (attribute) Algorithm 1 半 角 1 以 上 Reference 対 象 に 対 する 正 規 化 に 使 用 するアルゴ リズム DigestMethod データ Reference 対 象 に 対 する (attribute) 1 半 角 1 以 上 ダイジェスト 計 算 に 使 用 Algorithm するアルゴリズム DigestValue 1 半 角 1 以 上 構 成 定 義 の 計 算 対 象 52

62 SignatureValue 1 半 角 1 以 上 SignatureMethod で 指 定 したアルゴリズムで 生 成 された 署 名 値 ( 1) KeyInfo データ X509Data データ 署 名 付 与 に 使 用 した 証 明 X509Certificate 1 半 角 1 以 上 書 の Base64 エンコード 値 ( 1) 上 記 XML 内 の(attribute)は 属 性 を 指 します (attribute)という ではありません Signature タグの 詳 細 ついては 9.2.HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 構 成 を 参 照 してください 1. 署 名 情 報 の SignatureValue X509Certificate には 既 に 登 録 済 みの 有 効 期 限 が 切 れていない 公 開 鍵 証 明 書 の 情 報 を 指 定 します 2. DelX509Certificate には 削 除 する 公 開 鍵 証 明 書 の 情 報 を 設 定 します 応 答 結 果 XML XML 宣 言 <?xml version="1.0" encoding="utf-8"?> 必 須 文 字 種 桁 数 返 却 内 容 DataRoot Result 処 理 結 果 Code 1 英 数 字 1 処 理 結 果 コード ( 正 常 時 :0/エラー 時 :1) Message 1 全 半 角 256 以 下 メッセージ ApplData データ UserID 1 英 数 字 12 以 下 証 明 書 識 別 情 報 を 削 除 し た 利 用 者 ID LastAuthenticationDate 1 - 英 数 字 14 前 回 認 証 が 成 功 した 日 時 [yyyymmddhhmmss] エラー 時 は 空 HTTP レスポンスコード 返 却 値 内 容 200 OK 正 常 時 400 Bad Request API 利 用 ソフトウェア 起 因 によるエラー 発 生 時 401 Unauthorized 認 証 処 理 でエラー 発 生 時 500 Internal Server Error サーバ 内 処 理 でエラー 発 生 時 53

63 4. メッセージ では 別 紙 1 メッセージ 一 覧 の 内 容 を 各 応 答 結 果 XML の 処 理 結 果 の<Message> 欄 に 設 定 します 5. ステータス 管 理 e-gov 電 子 申 請 システムでは 各 申 請 データの 申 請 処 理 状 況 や 納 付 状 況 等 のステータスを 以 下 の ように 管 理 しています 応 答 結 果 XML にて 返 却 されるステータスについては 別 紙 2 コードリファレンス も 併 せて 参 照 してください 応 答 結 果 XML における Status タグ( 現 在 の 状 況 または 申 請 状 況 )においては メイン ステータスとサブステータスを 組 み 合 わせた 形 で 返 却 されます ただし サブステータスが なし の 場 合 は メインステータスのみ 返 却 されます 例 サブステータスが なし 以 外 の 場 合 [ 状 態 ] メインステータス: 審 査 中 サブステータス: 補 正 待 ち の 場 合 [ 返 却 値 ] 審 査 中 ( 補 正 待 ち) サブステータスが なし の 場 合 [ 状 態 ] メインステータス: 審 査 中 サブステータス:なし の 場 合 [ 返 却 値 ] 審 査 中 5.1. メインステータス ステータス 内 容 到 達 申 請 データが 正 常 に 受 け 付 けされた 状 態 審 査 中 申 請 データに 対 し 府 省 側 での 審 査 を 行 っている 状 態 審 査 終 了 申 請 データに 対 する 府 省 側 での 審 査 が 終 了 している 状 態 手 続 終 了 申 請 データに 対 する 手 続 が 終 了 している 状 態 5.2. サブステータス ステータス 内 容 補 正 待 ち 補 正 ( 再 提 出 ) 補 正 ( 部 分 補 正 )の 受 け 付 け 待 ちの 状 態 取 下 げ 処 理 中 取 下 げ 要 求 された 申 請 データの 取 下 げ 処 理 を 行 っている 状 態 取 下 げ 済 み 取 下 げ 要 求 された 申 請 データの 取 下 げ 処 理 が 終 了 している 状 態 再 提 出 済 み 補 正 ( 再 提 出 ) 補 正 ( 部 分 補 正 )の 受 け 付 けした 状 態 なし 補 正 がない 状 態 54

64 5.3. 納 付 状 況 ステータス 納 付 待 ち 手 数 料 が 未 納 の 状 態 納 付 済 み 手 数 料 が 完 納 した 状 態 納 付 期 限 切 れ 納 付 期 限 が 切 れた 状 態 取 消 し 済 み 取 消 し 処 理 がされた 状 態 納 付 不 要 納 付 の 必 要 がない 状 態 内 容 5.4. 申 請 後 の 申 請 ステータス 自 動 遷 移 について テスト 用 に 提 供 している 特 定 の 手 続 については 定 期 的 に 決 められたステータスに 遷 移 します API を 用 いたソフトウェアの 動 作 確 認 や 最 終 確 認 試 験 実 施 にあたり 特 定 のステータスに 対 する 確 認 を 実 施 する 際 は 一 括 申 請 API を 用 いて 対 象 の 手 続 を 申 請 したうえ 適 宜 ステータスを 確 認 し 動 作 確 認 又 は 最 終 確 認 試 験 を 実 施 してください なお 対 象 手 続 とステータスの 遷 移 については API テスト 用 手 続 一 覧 別 紙 _API テスト 用 手 続 ステータス 遷 移 一 覧 を 参 照 してください 6. コード 定 義 では 以 下 の については コード 値 で 管 理 をしています 応 答 結 果 XML にて 返 却 されるコード 値 と 説 明 については 別 紙 2 コードリファレンス も 併 せて 参 照 し てください 6.1. 処 理 結 果 コード コード 値 名 称 備 考 0 正 常 - 1 エラー 取 下 げ 可 能 フラグ コード 値 名 称 備 考 0 不 可 - 1 可 取 下 げ 方 法 コード 値 名 称 備 考 0 取 下 げなし - 1 取 下 げ 依 頼 - 2 取 下 げ 申 請 - 55

65 6.4. 補 正 可 能 フラグ コード 値 名 称 備 考 0 不 可 - 1 可 基 本 情 報 申 請 書 補 正 フラグ コード 値 名 称 備 考 0 補 正 なし - 1 補 正 あり 基 本 情 報 添 付 資 料 補 正 フラグ コード 値 名 称 備 考 0 補 正 なし - 1 補 正 あり 有 効 期 限 フラグ コード 値 名 称 備 考 0 有 効 期 限 内 - 1 有 効 期 限 切 れ 納 付 フラグ コード 値 名 称 備 考 0 電 子 納 付 不 可 - 1 電 子 納 付 可 - 56

66 7. 申 請 データと 到 達 番 号 の 対 応 付 け API 利 用 ソフトウェアが 保 持 する 申 請 データと e-gov 電 子 申 請 システムによる 形 式 チェック 後 に 付 番 される 到 達 番 号 は 申 請 案 件 フォルダ 名 で 対 応 付 けすることが 可 能 です 一 括 申 請 デー タ 作 成 の 際 申 請 案 件 フォルダ 名 は 申 請 データ 単 位 に 一 意 となるフォルダ 名 で 作 成 する 必 要 が あります ( 詳 細 は 申 請 データ 仕 様 書 共 通 データ 仕 様 書 を 参 照 ) 送 信 案 件 一 覧 情 報 取 得 及 び 申 請 案 件 一 覧 情 報 取 得 の 応 答 結 果 XML により e-gov 電 子 申 請 システム から API 利 用 ソフトウェアに 対 し 到 達 番 号 と 合 わせて 申 請 案 件 フォルダ 名 を 応 答 します API 利 用 ソフトウェアは 申 請 案 件 フォルダ 名 を 使 用 し どの 申 請 データにどの 到 達 番 号 が 付 与 され たかを 対 応 付 けすることができます 図 7-1 申 請 データと 到 達 番 号 の 対 応 付 け 57

67 8. 検 証 環 境 を 利 用 するための 留 意 事 項 検 証 環 境 は e-gov 電 子 申 請 システムとは 別 の 接 続 先 となります また 接 続 時 に Basic 認 証 が 必 要 です 検 証 環 境 を 利 用 する 場 合 は API 利 用 ソフトウェアに 対 して 以 下 の 設 定 を 行 ってくだ さい 8.1. Basic 認 証 検 証 環 境 への 接 続 時 には Basic 認 証 が 必 要 です API 利 用 ソフトウェアの 開 発 者 は HTTP リク エストの HTTP ヘッダ 部 のうち Authorization の に Basic 認 証 用 の 情 報 を 設 定 してください 設 定 値 は 検 証 環 境 利 用 通 知 書 に 記 載 された Basic 認 証 用 ID と Basic 認 証 用 パスワードを 半 角 コロンで 連 結 し Base64 でエンコードした 値 となります 以 下 に 例 を 示 します ( 例 ) 検 証 環 境 利 用 通 知 書 に 記 載 された Basic 認 証 用 ID とパスワードが 以 下 の 場 合 Basic 認 証 用 ID が ApiUser001 Basic 認 証 用 パスワードが ApiPass001 ApiUser001:ApiPass001 の 文 字 列 を Base64 にエンコードします Base64 のエンコード 値 は QXBpVXNlcjAwMTpBcGlQYXNzMDAx HTTP リクエストの HTTP ヘッダ 部 の Authorization に 以 下 のように 設 定 します Authorization: Basic QXBpVXNlcjAwMTpBcGlQYXNzMDAx API 利 用 ソフトウェアの 開 発 者 は 検 証 環 境 利 用 申 込 みにより Basic 認 証 用 ID と Basic 認 証 用 パスワードを 入 手 できます 8.2. リクエスト URI 検 証 環 境 は e-gov 電 子 申 請 システムとは 接 続 先 が 異 なります 各 API のリクエスト URI にある api.e-gov.go.jp を 検 証 環 境 用 の 接 続 先 URI に 変 更 してください API 利 用 ソフトウェアの 開 発 者 は 検 証 環 境 利 用 申 込 みを 行 うことで 検 証 環 境 用 の 接 続 先 URI を 入 手 できます 58

68 9. HTTP リクエストのボディ 部 に 指 定 する XML の 電 子 署 名 情 報 について では API 経 由 で e-gov 電 子 申 請 システムを 利 用 する 国 民 等 利 用 者 を 電 子 署 名 用 の 証 明 書 により 認 証 する 仕 様 としています API 利 用 ソフトウェアは 以 下 の API を 利 用 する 場 合 電 子 申 請 を 行 う 一 般 国 民 等 利 用 者 の 電 子 署 名 用 証 明 書 を 使 用 して 電 子 署 名 した XML を HTTP リクエストのボディ 部 に 指 定 し e-gov 電 子 申 請 システムに 送 信 する 必 要 があります 利 用 者 ID 登 録 利 用 者 認 証 証 明 書 識 別 情 報 登 録 証 明 書 識 別 情 報 更 新 証 明 書 識 別 情 報 削 除 上 記 API で 利 用 可 能 な 電 子 署 名 用 証 明 書 は 政 府 共 通 認 証 基 盤 (GPKI)のブリッジ 認 証 局 と 相 互 認 証 を 行 っている 認 証 局 から 発 行 された 証 明 書 とします 相 互 認 証 を 行 っている 認 証 局 については 申 請 データ 仕 様 共 通 データ 仕 様 書 の 5.4. e-gov 電 子 申 請 システムで 利 用 可 能 な 証 明 書 につ いて を 参 照 してください 以 下 で HTTP ボディ 部 に 指 定 する XML に 付 与 する 電 子 署 名 について 説 明 します 59

69 9.1. HTTP ボディ 部 に 指 定 する XML に 対 する 電 子 署 名 の 考 え 方 e-gov 電 子 申 請 システム API 利 用 ソフトウェアは API 仕 様 書 の 送 信 パラメータの HTTP ボディ 部 に 記 載 されている XML の ApplData タグに 対 して 一 般 国 民 等 利 用 者 の 電 子 署 名 用 証 明 書 から 署 名 に 必 要 となる 情 報 を 取 得 し XML 署 名 を 付 与 します 図 9-1 HTTP ボディ 部 に 指 定 する XML に 対 する 電 子 署 名 の 考 え 方 証 明 書 識 別 情 報 登 録 と 証 明 書 識 別 情 報 更 新 及 び 証 明 書 識 別 情 報 削 除 の API については 公 開 鍵 証 明 書 情 報 を ApplData タグ 及 び 署 名 情 報 の 中 に 設 定 しますが それぞれ 設 定 する 証 明 書 情 報 が 異 なります 9.3.HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 設 定 例 を 参 照 して ください 60

70 9.2. HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 構 成 (1) HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 のタグ 構 成 e-gov 電 子 申 請 システム 表 9-1 HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 のタグ 構 成 署 名 情 報 し 数 設 定 値 Signature 1 以 下 の2つの 属 性 を 指 定 します (1)xmlns 値 :" (2)Id 値 : 署 名 付 与 を 行 った 日 時 (フォーマット: yyyymmddhhmmss ) SignedInfo 1 CanonicalizationMethod 1 以 下 の 属 性 を 指 定 します (1) Algorithm 値 : " SignatureMethod 1 以 下 の 属 性 を 指 定 します (1) Algorithm SHA-1 にて 署 名 を 行 った 場 合 値 :" SHA-256 にて 署 名 を 行 った 場 合 値 : " Reference 1 署 名 対 象 とする 構 成 管 理 XML 申 請 書 XML 添 付 ファイル Transforms 1 の 数 に 応 じて 設 定 します 設 定 内 容 については 9.2(2) Reference の 設 定 について を 参 照 してください Transform 1 DigestMethod 1 DigestValue 1 SignatureValue 1 SignatureMethod タグの 属 性 で 指 定 したアルゴリズムで 生 成 された 署 名 値 を 設 定 します 署 名 値 の 生 成 対 象 は SignedInfo エレメントとなります KeyInfo 1 署 名 付 与 に 使 用 した 証 明 書 に 係 る 情 報 を 設 定 します X509Data 1 X509Certificate 1 署 名 付 与 に 使 用 した 証 明 書 の Base64 エンコード 値 を 設 定 します 途 中 で 改 行 する 場 合 は 76 文 字 ごとに 改 行 します 61

71 (2)Reference の 設 定 について Reference 内 のエレメントに 設 定 する 値 は 以 下 のとおりとします 表 9-2 Reference の 設 定 値 タグ 名 属 性 名 設 定 値 Reference URI #ApplData (ApplData タグに 対 する 署 名 とします) Transform Algorithm " DigestMethod Algorithm SHA-256 を 使 用 した 場 合 " SHA-1 を 使 用 した 場 合 " DigestValue ダイジェスト 値 の 計 算 対 象 は ApplData タグ 62

72 9.3. HTTP リクエストのボディ 部 に 指 定 する XML の 署 名 情 報 タグ 設 定 例 (1) 利 用 者 ID 登 録 と 利 用 者 認 証 の 場 合 e-gov 電 子 申 請 システム 図 9-2 利 用 者 ID 登 録 と 利 用 者 認 証 の XML 署 名 情 報 設 定 例 63

73 (2) 証 明 書 識 別 情 報 の 追 加 証 明 書 識 別 情 報 を 追 加 する 場 合 は 新 規 追 加 する 公 開 鍵 証 明 書 の 情 報 を ApplData タグ 内 に 設 定 します 既 に 登 録 済 みの 公 開 鍵 証 明 書 を 使 用 し XML の ApplData タグに 対 する 署 名 を 付 与 しま す 図 9-3 証 明 書 識 別 情 報 追 加 の XML 署 名 情 報 設 定 例 64

74 (3) 証 明 書 識 別 情 報 の 更 新 証 明 書 識 別 情 報 を 更 新 する 場 合 は 有 効 期 限 が 切 れた 公 開 鍵 証 明 書 の 情 報 を ApplData タグ 内 に 設 定 します ただし 設 定 する 有 効 期 限 が 切 れた 電 子 署 名 用 証 明 書 は 証 明 書 識 別 情 報 が e-gov 電 子 申 請 システム 内 に 登 録 されており ApplData タグ 内 の 利 用 者 ID と 対 応 づけられ 登 録 されて いるものでなければなりません 新 しく 追 加 する 有 効 期 限 が 切 れてない 電 子 署 名 用 証 明 書 を 使 用 し ApplData タグに 対 する 署 名 を 付 与 します なお 電 子 署 名 用 証 明 書 が 失 効 した 場 合 に 関 しても 有 効 期 限 が 切 れた 電 子 署 名 用 証 明 書 を 更 新 する 手 順 と 同 様 の 手 順 にて 証 明 書 識 別 情 報 の 更 新 を 行 ってください 図 9-4 証 明 書 識 別 情 報 更 新 の XML 署 名 情 報 の 設 定 例 65

75 (4) 証 明 書 識 別 情 報 の 削 除 証 明 書 識 別 情 報 を 削 除 する 場 合 は 削 除 対 象 とする 公 開 鍵 証 明 書 の 識 別 情 報 を ApplData タグ 内 に 設 定 します ただし 削 除 対 象 とする 公 開 鍵 証 明 書 は 証 明 書 識 別 情 報 が e-gov 電 子 申 請 シ ステム 内 に 登 録 されており ApplData タグ 内 の 利 用 者 ID と 対 応 づけられ 登 録 されているもので なければなりません すでに 識 別 情 報 が 登 録 されている 電 子 署 名 用 証 明 書 を 使 用 し ApplData タグに 対 する 署 名 を 付 与 します 図 9-5 証 明 書 識 別 情 報 削 除 の XML 署 名 情 報 の 設 定 例 なお 証 明 書 識 別 情 報 削 除 では 利 用 者 ID に 対 して 登 録 されている 証 明 書 識 別 情 報 が 1 件 だけ の 場 合 API を 利 用 して 登 録 済 みの 証 明 書 識 別 情 報 を 削 除 することができません API 利 用 ソフト ウェアの 開 発 者 が 利 用 者 ID に 対 して 1 件 だけ 登 録 されている 証 明 書 識 別 情 報 を 削 除 したい 場 合 は 利 用 ガイド の 3.1 ソフトウェア ID 利 用 者 ID を 使 用 しなくなった 場 合 の 対 応 に 記 載 の 手 順 にしたがって 利 用 者 ID の 削 除 申 込 みを 行 ってください 66