e-Gov電子申請API (1.0.0)

Download OpenAPI specification:Download

電子申請

手続選択:指定したAPI対象手続に係る申請データ構造(スケルトン)一式を取得する。

事前登録された基本情報と選択された手続識別子をもとに電子申請を行うための申請データ構造として基本情報をセットしたデータ一式を取得する。

path Parameters
proc_id
required
string 16 characters

手続識別子
・16桁
・半角英数字

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

プレ印字データ取得:プレ印字データを取得する。

プレ印字対象手続に対して、府省に問い合わせて、府省に登録されているプレ印字データを取得して返却する。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
required
Array of objects[ items ]

申請届出識別情報
繰り返し回数1~10

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データ
・半角
・バイナリデータはBASE64エンコードしたものを使用する。

Responses

Request samples

Content type
application/json
{
  • "application_info": [
    ],
  • "proc_id": "stringstringstri",
  • "form_id": "stringstringstring",
  • "form_version": 1,
  • "file_data": "string"
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

申請データ送信:申請データの形式チェックと到達確認を行い、到達番号等を取得する。

送信された申請データの形式チェックと申請処理を行い、到達番号等を応答する。
再提出を行う場合は、申請データ送信または、申請データbulk送信を使用する。
その際、申請するデータの「初回受付番号」には申請受付番号の初回受付時の到達番号、「申請種別」には"再提出"を指定する。設定方法の詳細は、申請データ仕様共通データ仕様書を参照。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Request Body schema: application/json
proc_id
required
string 16 characters

手続識別子
・半角英数字

required
object

申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "proc_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    },
  • "_links": {
    }
}

申請データbulk送信:複数の申請データを送信し、形式チェック(バッチ)に引き渡す情報を登録する。

送信された複数の申請データを受信し、後続の一括申請開始バッチに引き継ぐ情報を登録する。
再提出を行う場合は、申請データ送信または、申請データbulk送信を使用する。
その際、申請するデータの「初回受付番号」には申請受付番号の初回受付時の到達番号、「申請種別」には"再提出"を指定する。設定方法の詳細は、申請データ仕様共通データ仕様書を参照。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Request Body schema: application/json
required
object

1つ以上の申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    },
  • "_links": {
    }
}

補正データ送信:補正データの形式チェックを行い、補正を行う。

補正申請可能な到達番号に対して、
送信された補正データの形式チェックを行い、指定された到達番号の申請案件に関する補正処理を行う。
※補正申請可能な到達番号について
 ・申請案件に関する通知取得の補正種別が"部分補正"であること。
 ・補正種別が"再提出"、"手続終了(再提出可)"の場合は、申請データ送信、申請データbulk送信を使用すること。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字

required
object

補正対象データをZIPファイル形式で圧縮したものを設定
構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "arrive_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

取り下げ依頼送信:取下げ依頼を行う。

指定された到達番号の取下げ処理を行う。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
arrive_id
required
string [ 16 .. 18 ] characters

到達番号
・半角数字

required
object

取下げ依頼データをZIPファイル形式で圧縮したものを設定
構成管理XMLファイル、取下げ依頼の申請書XMLファイル

Responses

Request samples

Content type
application/json
{
  • "arrive_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

形式チェック実行:申請データに対する形式チェックの実行結果を取得する。

送信された申請データに対して、形式チェックを実行し、結果を応答する。

header Parameters
Content-Type
required
string

application/jsonを設定
JSON文書

Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

Request Body schema: application/json
proc_id
required
string 16 characters

手続識別子
・半角英数字

required
object

申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル

Responses

Request samples

Content type
application/json
{
  • "proc_id": "stringstringstri",
  • "send_file": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": {
    }
}

申請案件一覧取得:申請案件の一覧情報を取得する。

期間等を指定して、申請案件の一覧情報を取得する。対象期間内の到達日時の申請案件を取得対象とする。
※送信番号のみを指定または対象期間及び取得件数/ページを指定
 送信番号指定時 例: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

query Parameters
send_number
string 18 characters

送信番号
・半角数字
・18桁
・送信番号で取得する場合のみ指定

date_from
string <date> 10 characters

取得対象期間開始日
・半角
・10桁
・YYYY-MM-DD
 例:2017-09-01
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

date_to
string <date> 10 characters

取得対象期間終了日
・半角
・10桁
・YYYY-MM-DD
 例:2017-09-01
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

limit
integer <int32> [ 1 .. 50 ]

取得件数
・数字
・1-2桁
・上限値50
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

offset
integer <int32> [ 1 .. 9999 ]

取得ページ番号
・数字
・1-4桁
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定

header Parameters
Authorization
required
string

アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定

X-eGovAPI-Trial
boolean

トライアルでAPIを動作させる場合は"true"を設定
指定なしの場合は非トライアルで動作

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "resultset": {
    },
  • "results": {
    },
  • "_links": {