Download OpenAPI specification:Download
事前登録された基本情報と選択された手続識別子をもとに電子申請を行うための申請データ構造として基本情報をセットしたデータ一式を取得する。
proc_id required | string 16 characters 手続識別子 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "file_data": "string",
- "configuration_file_name": [
- "string"
], - "file_info": [
- {
- "form_id": "stringstringstring",
- "form_version": 1,
- "form_name": "string",
- "apply_file_name": "string",
- "xsl_file_name": "string",
- "server_check_file_name": "string",
- "schema_file_name": "string",
- "style_indication_file": "string"
}
]
}
}
プレ印字対象手続に対して、府省に問い合わせて、府省に登録されているプレ印字データを取得して返却する。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
required | Array of objects[ items ] 申請届出識別情報 |
proc_id required | string 16 characters 手続識別子 |
form_id required | string 18 characters 様式ID |
form_version required | integer <int32> [ 1 .. 9999 ] 様式バージョン |
file_data required | string <byte> non-empty 申請書XMLデータ |
{- "application_info": [
- {
- "label": "string",
- "value": "string"
}
], - "proc_id": "stringstringstri",
- "form_id": "stringstringstring",
- "form_version": 1,
- "file_data": "string"
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "apply_file": {
- "file_name": "string",
- "file_data": "string"
}
}
}
送信された申請データの形式チェックと申請処理を行い、到達番号等を応答する。
再提出を行う場合は、申請データ送信または、申請データbulk送信を使用する。
その際、申請するデータの「初回受付番号」には申請受付番号の初回受付時の到達番号、「申請種別」には"再提出"を指定する。設定方法の詳細は、申請データ仕様共通データ仕様書を参照。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
proc_id required | string 16 characters 手続識別子 |
required | object 申請データをZIPファイル形式で圧縮したものを設定 |
{- "proc_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "arrive_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "apply_type": "stri",
- "proc_name": "string",
- "ministry_name": "string",
- "submission_destination": "string",
- "apply_form": {
- "form": [
- {
- "form_name": "string"
}
], - "attached_file": [
- {
- "attached_file_name": "string"
}
]
}, - "apply_pay_list": [
- {
- "pay_number": "stringstringstri",
- "confirm_number": "string",
- "facility_number": "strin",
- "pay_name_kana": "string",
- "total_fee": 2147483647,
- "pay_expired": "2019-08-24"
}
]
}, - "_links": {
- "self": "string",
- "status": "string"
}
}
送信された複数の申請データを受信し、後続の一括申請開始バッチに引き継ぐ情報を登録する。
再提出を行う場合は、申請データ送信または、申請データbulk送信を使用する。
その際、申請するデータの「初回受付番号」には申請受付番号の初回受付時の到達番号、「申請種別」には"再提出"を指定する。設定方法の詳細は、申請データ仕様共通データ仕様書を参照。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
required | object 1つ以上の申請データをZIPファイル形式で圧縮したものを設定 |
{- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "send_number": "stringstringstring",
- "send_date": "stringstringstrings",
- "file_name": "string",
- "apply_count": 1
}, - "_links": {
- "self": "string",
- "list": "string",
- "report": "string"
}
}
補正申請可能な到達番号に対して、
送信された補正データの形式チェックを行い、指定された到達番号の申請案件に関する補正処理を行う。
※補正申請可能な到達番号について
・申請案件に関する通知取得の補正種別が"部分補正"であること。
・補正種別が"再提出"、"手続終了(再提出可)"の場合は、申請データ送信、申請データbulk送信を使用すること。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
required | object 補正対象データをZIPファイル形式で圧縮したものを設定 |
{- "arrive_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "amend_date": "stringstringstrings"
}
}
指定された到達番号の取下げ処理を行う。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
arrive_id required | string [ 16 .. 18 ] characters 到達番号 |
required | object 取下げ依頼データをZIPファイル形式で圧縮したものを設定 |
{- "arrive_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "arrive_id": "stringstringstri",
- "withdraw_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "proc_name": "string",
- "ministry_name": "string",
- "submission_destination": "string"
}
}
送信された申請データに対して、形式チェックを実行し、結果を応答する。
Content-Type required | string application/jsonを設定 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
proc_id required | string 16 characters 手続識別子 |
required | object 申請データをZIPファイル形式で圧縮したものを設定 |
{- "proc_id": "stringstringstri",
- "send_file": {
- "file_name": "string",
- "file_data": "string"
}
}
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "results": {
- "message": "string",
- "error_count": 1,
- "report_list": [
- {
- "form_name": "string",
- "attached_file_name": "string",
- "file_name": "string",
- "item": "string",
- "content": "string"
}
]
}
}
期間等を指定して、申請案件の一覧情報を取得する。対象期間内の到達日時の申請案件を取得対象とする。
※送信番号のみを指定または対象期間及び取得件数/ページを指定
送信番号指定時 例:https://api.e-gov.go.jp/shinsei/v1/apply/lists?send_number=123456789012345678
対象期間及び取得件数/ページを指定時 例:https://api.e-gov.go.jp/shinsei/v1/apply/lists?date_from=2019-01-01&date_to=2019-02-28&limit=50&offset=0
send_number | string 18 characters 送信番号 |
date_from | string <date> 10 characters 取得対象期間開始日 |
date_to | string <date> 10 characters 取得対象期間終了日 |
limit | integer <int32> [ 1 .. 50 ] 取得件数 |
offset | integer <int32> [ 1 .. 9999 ] 取得ページ番号 |
Authorization required | string アクセストークン取得リクエストにより取得したアクセストークン |
X-eGovAPI-Trial | boolean トライアルでAPIを動作させる場合は"true"を設定 |
{- "metadata": {
- "title": "string",
- "detail": "string",
- "type": "string",
- "instance": "string"
}, - "resultset": {
- "all_count": 1,
- "limit": 1,
- "offset": 1,
- "count": 1
}, - "results": {
- "apply_list": [
- {
- "no": 1,
- "send_number": "string",
- "send_date": "string",
- "status": "string",
- "arrive_id": "stringstringstri",
- "arrive_date": "stringstringstrings",
- "corporation_name": "string",
- "applicant_name": "string",
- "proc_name": "string",
- "submission_destination": "string",
- "withdraw_flag": true,
- "pay_status": "string",
- "notice_count": 1,
- "doc_count": 1,
- "apply_pay_count": 1,
- "notice_list": [
- {
- "notice_sub_id": 1,
- "issue_date": "stringstringstrings",
- "notice_data_type": "stri",
- "notice_title": "string",
- "notice_sentence": "string",
- "issuer_organization": "string",
- "correct_expired_date": "2019-08-24",
- "correct_completed_date": "2019-08-24"
}
], - "official_list": [
- {
- "notice_sub_id": 1,
- "allowed_date": "stringstringstrings",
- "doc_title": "string",
- "doc_download_expired_date": "2019-08-24",
- "doc_download_date": "2019-08-24",
- "sign": "st"
}
], - "apply_pay_list": [
- {
- "pay_number": "stringstringstri",
- "confirm_number": "string",
- "facility_number": "strin",
- "pay_name_kana": "string",
- "total_fee": 2147483647,
- "pay_expired": "2019-08-24"
}
]
}
]
}, - "_links": {
- "self": "string",
- "previous": "string",