別紙2 外部連携API応答結果XMLコードリファレンス

別紙2 外部連携API応答結果XMLコードリファレンス
応答結果XML
/送信パラメータ
項目
項目名
値
0
Code
Status
PayStatus
CorrectStatus
説明
e-Govによる処理が正常に終了した場合に返却されます。
エラー時
電子納付金融機関サイト表示を
e-Govによる処理がエラーで終了した場合に返却されます。
除く全てのAPI
応答結果XMLの「Result」タグ内の「Message」タグを参照し、送信内容を確認してください。
なお、実行するAPIによっては「Error」タグ内の「Content」タグ、もしくは「ApplData」タグ内の
「ErrorFile」タグにもエラーに係る情報が返却されている場合がありますので、そちらも併せて参照してく
ださい。
処理待ち
-
e-Govによる一括申請処理が処理待ちの場合に返却されます。
空白
-
e-Govによる一括申請処理が終了した場合に返却されます。
到達
-
e-Govに申請データが到達した状態の場合に返却されます。
到達(取下げ処理中)
-
e-Govに申請データが到達し、手続所管府省において申請データの審査が開始される前に取下げを実施した状
態であり、取下げに係る処理中である場合に返却されます。
審査中
-
府省システムに対してe-Govに到達した申請データを連携し、手続所管府省において申請データの審査中であ
る状態の場合に返却されます。
審査中(取下げ処理中)
-
府省システムに対してe-Govに到達した申請データを連携し、手続所管府省において申請データの審査中に取
下げを実施した状態であり、取下げに係る処理中である場合に返却されます。
審査中(補正待ち)
-
府省システムに対してe-Govに到達した申請データを連携し、手続所管府省より申請データに対して補正指示
送信案件一覧情報取得
が出ている場合に返却されます。
申請案件一覧情報取得
審査終了
-
府省システムに対してe-Govに到達した申請データを連携し、手続所管府省において申請データの審査が完了
している場合に返却されます。
手続終了
-
手続所管府省において申請に係る審査等の処理が全て終了している場合に返却されます。
手続終了(取下げ済み)
-
取下げの承認が手続所管府省にて完了している場合に返却されます。
※手続所管府省により取下げが却下された場合は取下げを行った際の状態となります。
手続終了(再提出済み)
-
補正が必要となった申請に対して、補正(再提出)または補正(補正申請)を行った状態の場合に返却され
ます。
※補正対象となった元到達番号に対する申請データが当ステータスの対象となります。
※補正(部分補正)を行った場合は手続所管府省より補正指示が出る前の状態となります。
納付待ち
-
納付が必要な手続において、手数料未納付の場合に返却されます。
納付済み
-
納付が必要な手続において、手数料納付済みの場合に返却されます。
納付期限切れ
-
納付が必要な手続において、手数料納付の期限が切れている場合に返却されます。
取消し済み
-
納付が必要な手続において、手数料納付が取消されている場合に返却されます。
なし
-
申請データに対する補正指示通知がない場合に返却されます。
※ただし、補正(補正申請)が可能な場合においても「なし」が返却されますので、補正(補正申請)の可
否の確認が必要な場合は、状況照会を実行した際の「ReintroductionFlag」タグを参照してください。
処理結果コード
処理状態
現在の状況
送信案件一覧情報取得
納付状況
補正状況
使用箇所
正常時
1
WorkStatus
内容
1/6
送信案件一覧情報取得
申請案件一覧情報取得
状況照会
納付情報一覧取得
送信案件一覧情報取得
申請案件 覧情報取得
別紙2 外部連携API応答結果XMLコードリファレンス
応答結果XML
/送信パラメータ
項目
項目名
値
内容
説明
補 状況
Status
申請状況
使用箇所
申請案件一覧情報取得
あり
-
到達
-
到達(取下げ処理中)
-
審査中
-
審査中(取下げ処理中)
-
審査中(補正待ち)
-
審査終了
-
手続終了
-
手続終了(取下げ済み)
-
手続終了(再提出済み)
-
手続所管府省より、申請データに対する補正指示通知がある場合に返却されます。
項目「Status」、項目名「現在の状況」と同一の内容になりますので、
そちらの説明を参照してください。
状況照会
応答結果XML
0
WithdrawFlag
WithdrawType
ReintroductionFlag
OperatorType
ApplyStatus
不可
申請データに対する取下げが不可である場合に返却されます。
1
可
申請データに対する取下げが可能である場合に返却されます。
取下げを実行することにより、申請データを取下げる事ができます。
0
取下げなし
申請データに対する取下げが不可である場合に返却されます。
1
取下げ依頼
申請データに対する取下げ方法が、取下げ依頼である場合に返却されます。
取下げを行う場合は、取下げ依頼用の申請書XMLを使用してください。
2
取下げ申請
申請データに対する取下げ方法が、取下げ申請である場合に返却されます。
取下げを行う場合は、取下げ申請用の申請書XMLを使用してください。
0
不可
申請データに対する補正申請が不可である場合に返却されます。
1
可
申請データに対する補正申請が可能である場合に返却されます。
補正(補正申請)から、補正申請が可能です。
送信
-
申請者がアクションを行った事を起因としてデータが変更されたことを示します。
受信
-
手続所管府省がアクションを行った事を起因としてデータが変更されたことを示します。
システム
-
e-Govのシステムにより自動的にデータを変更したことを示します。
到達
-
状況照会
取下げ可能フラグ
取下げ方法
状況照会
補正申請可能フラグ
処理区分
申請状況
状況照会
到達(取下げ処理中)
-
審査中
-
審査中(取下げ処理中)
-
審査中(補正待ち)
-
審査終了
-
項目「Status」、項目名「現在の状況」と同一の内容になりますので、
そちらの説明を参照してください。
2/6
状況照会
状況照会
別紙2 外部連携API応答結果XMLコードリファレンス
応答結果XML
/送信パラメータ
項目
項目名
値
内容
手続終了
-
手続終了(取下げ済み)
-
手続終了(再提出済み)
-
説明
3/6
使用箇所
別紙2 外部連携API応答結果XMLコードリファレンス
応答結果XML
/送信パラメータ
項目
Type
項目名
値
内容
1
ウィルス
チェックエラー
e-Govによるウイルスチェックでエラーになった場合に返却されます。
送信したデータにウイルスが含まれている可能性があるため、送信データを確認してください。
2
構成管理
チェックエラー
e-Govによる構成管理チェックでエラーになった場合に返却されます。
構成管理ファイルが正しい内容になっているか確認してください。
3
申請書バージョン
チェックエラー
e-Govによる申請書バージョンチェックでエラーになった場合に返却されます。
申請書の様式バージョンが受付可能なバージョンとなっているか確認してください。
4
申請書項目
チェックエラー
e-Govによる申請書項目チェックでエラーになった場合に返却されます。
申請書項目が正しく入力されているか確認してください。
5
府省保有データ
照会チェックエラー
e-Govによる府省保有データ照会チェックでエラーになった場合に返却されます。
府省保有データ照会に必要なデータが正しい内容になっているか確認してください。
6
添付ファイル名重複
チェックエラー
e-Govによる添付ファイル名重複チェックでエラーになった場合に返却されます。
添付ファイルの名称が重複していないか確認してください。
7
添付ファイル数上限
チェックエラー
e-Govによる添付ファイル数上限チェックでエラーになった場合に返却されます。
添付ファイル数が上限値を超えていますので、送信するデータ内の添付ファイル数を減らしてください。
8
添付ファイル合計サイズ e-Govによる添付ファイル合計サイズチェックでエラーになった場合に返却されます。
チェックエラー
送信するデータの添付ファイルサイズを小さくしてください。
ApplyType
CorrectType
AmendDocType
DocType
使用箇所
取下げ
補正(再提出)
補正(部分補正)
補正(補正申請)
エラー種別
-
申請データに対する処理(※)がe-Govへ正常に到達した場合に返却されます。
※処理:取下げ、補正(再提出)、補正(部分補正)または、補正(補正申請)
エラー
-
申請データに対する処理(※)がe-Govへ正常に到達せずにエラーとなった場合に返却されます。
応答結果XMLの「Result」タグ内の「Message」タグまたは、「Error」タグ内の「Content」タグを参照し、
送信内容に問題がないか確認してください。
※処理:取下げ、補正(再提出)、補正(部分補正)または、補正(補正申請)
取下げ
-
取下げ申請の場合のみ返却されます。
※取下げ依頼の場合は空タグとなります。
0
部分補正
申請データに対する部分補正が可能である場合に返却されます。
補正(部分補正)から、部分補正が可能です。
1
再提出
申請データに対する再提出が可能である場合に返却されます。
補正(再提出)から、再提出が可能です。
1
基本情報・申請書
部分補正の対象が基本情報・申請書である場合に返却されます。
申請データの基本情報・申請書に対して部分補正が可能です。
2
添付・別送書類
部分補正の対象が添付・別送書類である場合に返却されます。
申請データの添付・別送書類に対して部分補正が可能です。
3
基本情報・申請書
と添付書類
部分補正の対象が基本情報・申請書と添付書類である場合に返却されます。
申請データの基本情報・申請書と添付・別送書類に対して部分補正が可能です。
4
任意
部分補正の対象が任意である場合に返却されます。
申請データの基本情報・申請書、添付・別送書類のいずれか、または両方に対して部分補正が可能です。
添付
-
補正を行う申請データの添付書類を、添付ファイルとして送信する場合に返却されます。
別送
-
補正を行う申請データの添付書類を、別送する場合に返却されます。
※別送とは別途定められた郵送先に対して申請に必となる資料の送付を行うことを示します。
到達
ArriveResult
説明
到達結果
申請区分
補正種別
部分補正種別
(※補正種別のコード値
が0の場合のみ設定され
る)
補正(再提出)
補正(補正申請)
補正(再提出)
補正(部分補正)
補正(補正申請)
取下げ
補正(再提出)
補正(部分補正)
補正(補正申請)
取下げ
補正通知一覧情報取得
補正通知一覧情報取得
添付種別
補正通知一覧情報取得
4/6
別紙2 外部連携API応答結果XMLコードリファレンス
応答結果XML
/送信パラメータ
項目
項目名
ApplyType
申請区分
Sign
署名有無
値
内容
説明
補正
-
補正(再提出)、補正(部分補正)または、補正(補正申請)を行った場合に返却されます。
あり
-
手続所管府省から発出されている公文書に署名がある場合に返却されます。
使用箇所
補正(再提出)
補正(部分補正)
補正(補正申請)
応答結果XML
公文書・コメント一覧取得
なし
ExpiredDateFlag
Reading
ValidationResult
CertificateResult
-
手続所管府省から発出されている公文書に署名がない場合に返却されます。
0
期限内
手続所管府省から発出されている公文書が有効期限内である場合に返却されます。
1
期限切れ
手続所管府省から発出されている公文書が有効期限切れである場合に返却されます。
未読
-
手続所管府省から発出されているコメントが未開封の場合に返却されます。
既読
-
手続所管府省から発出されているコメントが開封済みの場合に返却されます。
正常です。
-
e-Govによる署名検証結果が正常に終了した場合に返却されます。
問題があります。
-
e-Govによる署名検証結果に問題があった場合に返却されます。
応答結果XMLの「Error」タグ内の「Content」タグまたは、「VerifyResult」タグ内の
「CertificateResult」タグを参照し、送信内容を確認してください。
有効期限フラグ
公文書・コメント一覧取得
公文書・コメント一覧取得
開封状況
検証結果
証明書の検証結果
署名に使用されている官職証明書
が有効期間外です。
署名に使用されている証明書が有効期限外の場合に返却されます。
電子公文書に付されている署名又
は署名時に使用された官職証明書 が有効ではありません。
署名に使用されている証明書が有効でない場合に返却されます。
電子公文書が
改ざんされています。
PayFlag
BasicFormFlag
-
電子公文書が改ざんされている場合に返却されます。
0
電子納付不可
申請された手続きにおいて、手続所管府省への電子納付が不可である場合に返却されます。
1
電子納付可
申請された手続きにおいて、手続所管府省への電子納付が可能である場合に返却されます。
0
補正無
部分補正の対象が基本情報・申請書ではない場合に送信します。
1
補正有
部分補正の対象が基本情報・申請書である場合に送信します。
0
補正無
部分補正の対象が添付・別送書類ではない場合に送信します。
1
補正有
部分補正の対象が添付・別送書類である場合に送信します。
公文書署名検証
公文書署名検証
納付情報一覧取得
納付フラグ
基本情報・申請書補正フ
ラグ
補正(部分補正)
送信パラメータ
AttachedFlag
添付書類補正フラグ
補正(部分補正)
5/6
変更履歴
No
1
2
3
4
5
更新日
2015/3/18
2015/4/23
2015/4/23
2015/5/19
2015/5/19
変更箇所
応答結果XML-エラー種別
応答結果XML-処理状態
応答結果XML-納付フラグ
応答結果XML-納付状況
応答結果XML-納付フラグ
6
2015/8/12
応答結果XML-エラー種別
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
変更内容
エラー種別に申請書バージョンチェックエラーを追加。
「処理済」から「空白」へ修正。
電子納付可の場合の値を「s」から「1」へ修正。
使用箇所の「電子納付情報一覧取得」を「納付情報一覧取得」に修正。
使用箇所の「電子納付情報一覧取得」を「納付情報一覧取得」に修正。
エラー種別に添付ファイル名重複チェックエラー、添付ファイル数上限チェックエラー、添
付ファイル合計サイズチェックエラーを追加。