{
"openapi": "3.0.0",
"info": {
"description": "電子申請API v2のAPI仕様を表示しています。
従来のAPI仕様は、電子申請API v1を参照して下さい。",
"version": "2.0.0",
"title": "e-Gov電子申請API"
},
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2",
"description": "電子申請"
},
{
"url": "https://api.e-gov.go.jp/shinsei/v2",
"description": "電子送達"
},
{
"url": "https://api.e-gov.go.jp/shinsei/v2",
"description": "アカウント間情報共有"
},
{
"url": "https://account.e-gov.go.jp/auth",
"description": "利用者認証"
}
],
"paths": {
"/procedure/{proc_id}": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "手続選択:指定したAPI対象手続に係る申請データ構造（スケルトン）一式を取得する。",
"description": "事前登録された基本情報と選択された手続識別子をもとに電子申請を行うための申請データ構造として基本情報をセットしたデータ一式を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/proc_id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_procedure"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/preprint": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "プレ印字データ取得:プレ印字データを取得する。",
"description": "プレ印字対象手続に対して、府省に問い合わせて、府省に登録されているプレ印字データを取得して返却する。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"application_info",
"proc_id",
"form_id",
"form_version",
"file_data"
],
"properties": {
"application_info": {
"allOf": [
{
"$ref": "#/components/schemas/application_info"
}
]
},
"proc_id": {
"description": "手続識別子
・半角英数字",
"type": "string",
"minLength": 16,
"maxLength": 16
},
"form_id": {
"description": "様式ID
・半角英数字",
"type": "string",
"minLength": 18,
"maxLength": 18
},
"form_version": {
"description": "様式バージョン
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
},
"file_data": {
"description": "申請書XMLデータ
・半角
・バイナリデータはBASE64エンコードしたものを使用する。",
"type": "string",
"format": "byte",
"minLength": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_preprint"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/apply": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "申請データ送信：申請データの形式チェックと到達確認を行い、到達番号等を取得する。",
"description": "送信された申請データの形式チェックと申請処理を行い、到達番号等を応答する。
※再提出を行う場合も当APIを使用する。申請するデータの「初回受付番号」には申請受付番号の初回受付時の到達番号、「申請種別」には\"再提出\"を指定する。設定方法の詳細は、申請データ仕様共通データ仕様書を参照。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"proc_id",
"send_file"
],
"properties": {
"proc_id": {
"description": "手続識別子
・半角英数字",
"type": "string",
"minLength": 16,
"maxLength": 16
},
"send_file": {
"description": "申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル",
"allOf": [
{
"$ref": "#/components/schemas/data"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_apply"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_apply"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest_Report"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_Report"
},
"500": {
"$ref": "#/components/responses/InternalServerError_Report"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable_Report"
}
}
}
},
"/bulk-apply": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "申請データbulk送信:複数の申請データを送信し、形式チェック（バッチ）に引き渡す情報を登録する。",
"description": "送信された複数の申請データを受信し、後続の一括申請開始バッチに引き継ぐ情報を登録する。
※再提出を行う場合は、申請データ送信を使用すること。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"send_file"
],
"properties": {
"send_file": {
"description": "１つ以上の申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル",
"allOf": [
{
"$ref": "#/components/schemas/data"
}
]
}
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_bulk_apply"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_bulk_apply"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest_error"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_error"
},
"500": {
"$ref": "#/components/responses/InternalServerError_error"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable_error"
}
}
}
},
"/apply/amend": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "補正データ送信:補正データの形式チェックを行い、補正を行う。",
"description": "補正申請可能な到達番号に対して、
送信された補正データの形式チェックを行い、指定された到達番号の申請案件に関する補正処理を行う。
※補正申請可能な到達番号について
・申請案件に関する通知取得の補正種別が\"部分補正\"であること。
・補正種別が\"再提出\"、\"手続終了(再提出可)\"の場合は、申請データ送信を使用すること。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"arrive_id",
"send_file"
],
"properties": {
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"send_file": {
"description": "補正対象データをZIPファイル形式で圧縮したものを設定
構成管理XMLファイル、申請書XMLファイル、添付ファイル",
"allOf": [
{
"$ref": "#/components/schemas/data"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_apply_amend"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest_Report"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_Report"
},
"500": {
"$ref": "#/components/responses/InternalServerError_Report"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable_Report"
}
}
}
},
"/apply/withdraw": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "取り下げ依頼送信:取下げ依頼を行う。",
"description": "指定された到達番号の取下げ処理を行う。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"arrive_id",
"send_file"
],
"properties": {
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"send_file": {
"description": "取下げ依頼データをZIPファイル形式で圧縮したものを設定
構成管理XMLファイル、取下げ依頼の申請書XMLファイル",
"allOf": [
{
"$ref": "#/components/schemas/data"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_apply_withdraw"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest_Report_withdraw"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_Report_withdraw"
},
"500": {
"$ref": "#/components/responses/InternalServerError_Report_withdraw"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable_Report_withdraw"
}
}
}
},
"/apply/check": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "形式チェック実行:申請データに対する形式チェックの実行結果を取得する。",
"description": "送信された申請データに対して、形式チェックを実行し、結果を応答する。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"proc_id",
"send_file"
],
"properties": {
"proc_id": {
"description": "手続識別子
・半角英数字",
"type": "string",
"minLength": 16,
"maxLength": 16
},
"send_file": {
"description": "申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル",
"allOf": [
{
"$ref": "#/components/schemas/data"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_apply_check"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/apply/lists": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "申請案件一覧取得:申請案件の一覧情報を取得する。",
"description": "期間等を指定して、申請案件の一覧情報を取得する。対象期間内の到達日時の申請案件を取得対象とする。
※送信番号のみを指定または対象期間及び取得件数/ページを指定
送信番号指定時 例:https://api.e-gov.go.jp/shinsei/v2/apply/lists?send_number=123456789012345678
対象期間及び取得件数/ページを指定時 例:https://api.e-gov.go.jp/shinsei/v2/apply/lists?date_from=2019-01-01&date_to=2019-02-28&limit=50&offset=0",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial"
},
{
"$ref": "#/components/parameters/send_number"
},
{
"$ref": "#/components/parameters/date_from_optional"
},
{
"$ref": "#/components/parameters/date_to_optional"
},
{
"$ref": "#/components/parameters/limit_50_optional"
},
{
"$ref": "#/components/parameters/offset_optional"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"resultset",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"resultset": {
"allOf": [
{
"$ref": "#/components/schemas/result_set"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_apply_lists"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_lists_note"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/apply/{arrive_id}": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "申請案件取得:申請案件の詳細情報を取得する。",
"description": "指定した申請案件の詳細情報を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial"
},
{
"$ref": "#/components/parameters/arrive_id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_apply_detail"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/apply/report": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "エラーレポート取得:申請データbulk送信の申請データに対する形式チェックの実行結果に関するエラーレポートを取得する。",
"description": "申請データbulk送信の申請データに対して、後続の処理にて実行された形式チェックの実行結果を、取得して応答する。
リクエストの対象期間内に受信した申請データに対するエラーレポートを取得対象とする。
形式チェック実行にてチェックエラーが発生せずに到達した申請については、発行された到達番号等を応答する。
※送信番号のみを指定または対象期間及び取得件数/ページを指定
送信番号指定時 例:https://api.e-gov.go.jp/shinsei/v2/apply/report?send_number=123456789012345678
対象期間及び取得件数/ページを指定時 例:https://api.e-gov.go.jp/shinsei/v2/apply/report?date_from=2019-01-01&date_to=2019-02-28&limit=50&offset=0",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial"
},
{
"$ref": "#/components/parameters/send_number"
},
{
"$ref": "#/components/parameters/date_from_optional"
},
{
"$ref": "#/components/parameters/date_to_optional"
},
{
"$ref": "#/components/parameters/limit_30_optional"
},
{
"$ref": "#/components/parameters/offset_optional"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"resultset",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"resultset": {
"allOf": [
{
"$ref": "#/components/schemas/result_set"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_apply_report"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_lists_note"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/message/lists": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "手続に関するご案内一覧取得:手続に関するご案内情報のリストを取得する。",
"description": "期間等を指定して、手続に関するご案内情報を一覧で取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/date_from"
},
{
"$ref": "#/components/parameters/date_to"
},
{
"$ref": "#/components/parameters/limit_50"
},
{
"$ref": "#/components/parameters/offset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"resultset",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"resultset": {
"allOf": [
{
"$ref": "#/components/schemas/result_set"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_message_lists"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_lists"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/message/{information_id}": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "手続に関するご案内取得:お知らせ情報（手続に関するご案内）を取得する。",
"description": "指定したお知らせ（手続に関するご案内）の情報を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/information_id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_message"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/notice/lists": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "申請案件に関する通知一覧取得:申請案件に関する通知情報のリストを取得する。",
"description": "期間等を指定して、申請案件に関する通知情報を一覧で取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/date_from"
},
{
"$ref": "#/components/parameters/date_to"
},
{
"$ref": "#/components/parameters/limit_50"
},
{
"$ref": "#/components/parameters/offset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"resultset",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"resultset": {
"allOf": [
{
"$ref": "#/components/schemas/result_set"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_notice_lists"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_lists_note"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/notice/{arrive_id}/{notice_sub_id}": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "申請案件に関する通知取得:申請案件に関する通知情報を取得する。",
"description": "指定した申請案件に関する通知の情報を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/arrive_id"
},
{
"$ref": "#/components/parameters/notice_sub_id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_notice"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/official_document/{arrive_id}/{notice_sub_id}": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "公文書取得:公文書を取得する。",
"description": "指定された申請案件の公文書を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial"
},
{
"$ref": "#/components/parameters/arrive_id"
},
{
"$ref": "#/components/parameters/notice_sub_id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_official_document"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_official_document"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/official_document": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "公文書取得完了:公文書の取得日時を登録する。",
"description": "指定された申請案件の公文書の取得日時を登録する。
また、申請案件に紐づくすべての公文書が取得された状態となった場合は、申請案件のステータスを手続完了に更新する。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"arrive_id",
"notice_sub_id"
],
"properties": {
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"notice_sub_id": {
"description": "通知通番
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_official_document_complete"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/official_document/verify": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "公文書署名検証要求:公文書に付与された官職署名の検証を行う。",
"description": "送信された公文書に対して署名検証を行う。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"file_name",
"file_data",
"sig_verification_xml_file_name"
],
"properties": {
"file_name": {
"description": "ファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"file_data": {
"description": "ファイル圧縮データ
・半角
・鑑ファイル、添付ファイル
・バイナリデータはBase64エンコードしたものを使用する。",
"type": "string",
"format": "byte",
"minLength": 1
},
"sig_verification_xml_file_name": {
"description": "署名検証XMLファイル名
・半角英数字",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_official_document_verify"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/payment/lists": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "国庫金電子納付取扱金融機関一覧取得:国庫金電子納付が可能な金融機関一覧を取得する。",
"description": "電子納付金融機関一覧取得要求を受け付け、国庫金の電子納付が可能な金融機関一覧（金融機関名、ネットバンキングのサービス名、URL 等）を応答する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_payment_lists"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/payment/{arrive_id}": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"get": {
"tags": [
"電子申請"
],
"summary": "電子納付情報一覧取得:納付情報を取得する。",
"description": "指定された到達番号に発行された手数料等の納付情報（到達番号、納付番号、確認番号、収納期間番号等）を応答する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/arrive_id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_payment"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/payment": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子申請",
"post": {
"tags": [
"電子申請"
],
"summary": "電子納付金融機関サイト表示:電子納付金融機関サイトのURLを取得する。",
"description": "電子納付金融機関サイトのURL（リダイレクト先）およびリダイレクト先へ受け渡すパラメータ情報（収納機関番号、国庫金コード、パラメータタグ名、情報リンクデータ）を応答する。
応答結果を受け、API対応ソフトウェア開発事業者側で電子納付金融機関サイトのURLへリダイレクトさせる必要がある。
・電子納付金融機関サイトのURL「応答結果．URLの値」
※リダイレクト先へは以下のパラメータを受け渡す。（POST送信）
・パラメータ名「skno」、パラメータ値「応答結果．facility_number（収納機関番号）の値」
・パラメータ名「bptn」、パラメータ値「応答結果．treasury_money_code（国庫金コード）の値」
・パラメータ名「応答結果．parameter_tag_name（パラメータタグ名）の値」、パラメータ値「応答結果．information_link_data（情報リンクデータ）をBASE64デコードした値」",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"arrive_id",
"pay_number",
"bank_name",
"proc_id"
],
"properties": {
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"pay_number": {
"description": "納付番号
・半角英数字",
"type": "string",
"minLength": 16,
"maxLength": 16
},
"bank_name": {
"description": "金融機関名称
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"proc_id": {
"description": "手続識別子
・半角英数字",
"type": "string",
"minLength": 16,
"maxLength": 16
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_payment_site"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/post-apply": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子送達",
"post": {
"tags": [
"電子送達"
],
"summary": "電子送達利用申込み：申請データの形式チェックと到達確認を行い、到達番号等を取得する。",
"description": "送信された申請データの形式チェックと電子送達の申込み処理を行い、到達番号等を応答する。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"proc_id",
"send_file"
],
"properties": {
"proc_id": {
"description": "手続識別子
・半角英数字",
"type": "string",
"minLength": 16,
"maxLength": 16
},
"send_file": {
"description": "申請データをZIPファイル形式で圧縮したものを設定
申請データは構成管理XMLファイル、申請書XMLファイル、添付ファイル",
"allOf": [
{
"$ref": "#/components/schemas/data"
}
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_post_apply"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_apply"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest_Report"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_Report"
},
"500": {
"$ref": "#/components/responses/InternalServerError_Report"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable_Report"
}
},
"operationId": ""
}
},
"/post-apply/{arrive_id}": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子送達",
"get": {
"tags": [
"電子送達"
],
"summary": "電子送達状況確認:電子送達の申込状況を取得する。",
"description": "指定した電子送達の申込みの詳細情報を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON"
},
{
"$ref": "#/components/parameters/arrive_id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_post_apply_detail"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/post/lists": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子送達",
"get": {
"tags": [
"電子送達"
],
"summary": "電子送達一覧取得:電子送達のリストを取得する。",
"description": "期間等を指定して、電子送達に関する一覧情報を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/date_from"
},
{
"$ref": "#/components/parameters/date_to"
},
{
"$ref": "#/components/parameters/limit_50"
},
{
"$ref": "#/components/parameters/offset"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"resultset",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"resultset": {
"allOf": [
{
"$ref": "#/components/schemas/result_set"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_post_lists"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_lists"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/post/{post_id}": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子送達",
"get": {
"tags": [
"電子送達"
],
"summary": "電子送達取得:電子送達を取得する。",
"description": "指定された電子送達の通知文書を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON"
},
{
"$ref": "#/components/parameters/post_id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_post"
}
]
},
"_links": {
"allOf": [
{
"$ref": "#/components/schemas/links_official_document"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/post": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "電子送達",
"post": {
"tags": [
"電子送達"
],
"summary": "電子送達取得完了:電子送達の取得日時を登録する。",
"description": "指定された通知文書の取得日時を登録する。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"post_id"
],
"properties": {
"post_id": {
"description": "電子送達識別子
・半角英数字
・1-50桁",
"type": "string",
"minLength": 1,
"maxLength": 50
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_post_complete"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/share-setting/lists": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "アカウント間情報共有",
"get": {
"tags": [
"アカウント間情報共有"
],
"summary": "情報共有一覧取得:アカウント間情報共有の設定中の情報を応答する。",
"description": "アカウント間情報共有の設定中の情報を応答する。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON-share"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"resultset",
"results",
"_links"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_share_setting_lists"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/share-setting": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "アカウント間情報共有",
"post": {
"tags": [
"アカウント間情報共有"
],
"summary": "情報共有設定:指定されたアカウント間情報共有の設定を行う。",
"description": "指定されたアカウント間情報共有の設定を行う。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON-share"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"gbiz_id",
"official_doc_permission",
"post_doc_permission"
],
"properties": {
"gbiz_id": {
"description": "共有対象のgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"official_doc_permission": {
"description": "公文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
},
"post_doc_permission": {
"description": "電子送達の通知文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_share-setting-post"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
},
"put": {
"tags": [
"アカウント間情報共有"
],
"summary": "情報共有更新:指定されたアカウント間情報共有の更新を行う。",
"description": "指定されたアカウント間情報共有の更新を行う。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON-share"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"gbiz_id",
"official_doc_permission",
"post_doc_permission"
],
"properties": {
"gbiz_id": {
"description": "共有中のgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"official_doc_permission": {
"description": "公文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
},
"post_doc_permission": {
"description": "電子送達の通知文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_share-setting-put"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
},
"delete": {
"tags": [
"アカウント間情報共有"
],
"summary": "情報共有解除:指定されたアカウント間情報共有の解除を行う。",
"description": "指定されたアカウント間情報共有の解除を行う。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON-share"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"gbiz_id",
"official_doc_permission",
"post_doc_permission"
],
"properties": {
"gbiz_id": {
"description": "共有中で解除を実施したいgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_share-setting-delete"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/share-confirmation": {
"servers": [
{
"url": "https://api.e-gov.go.jp/shinsei/v2"
}
],
"description": "アカウント間情報共有",
"post": {
"tags": [
"アカウント間情報共有"
],
"summary": "共有設定確認:指定されたアカウント間情報共有の有効化設定を行う。",
"description": "指定されたアカウント間情報共有の有効化設定を行う。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type"
},
{
"$ref": "#/components/parameters/Authorization"
},
{
"$ref": "#/components/parameters/X-eGovAPI-Trial-NON-share"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"gbiz_id",
"share_acceptance"
],
"properties": {
"gbiz_id": {
"description": "共有依頼元のgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"share_acceptance": {
"description": "共有設定の許可/不許可
・半角
ACCEPT：許可する
DENY：許可しない",
"type": "string",
"minLength": 4,
"maxLength": 6
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"metadata",
"results"
],
"properties": {
"metadata": {
"description": "メタデータ",
"allOf": [
{
"$ref": "#/components/schemas/metadata_common"
}
]
},
"results": {
"description": "結果データ",
"allOf": [
{
"$ref": "#/components/schemas/results_share-confirmation"
}
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavaiable"
}
}
}
},
"/auth": {
"servers": [
{
"url": "https://account.e-gov.go.jp/auth"
}
],
"description": "利用者認証",
"get": {
"tags": [
"利用者認証"
],
"summary": "ユーザー認可:ユーザー認可リクエストを行い、認証・同意画面を表示する。",
"description": "e-Gov認可サーバの認証・同意画面を返却後、ユーザーがログイン及び同意を実施することにより認可コードが発行される。
全項目指定時
例：https://account.e-gov.go.jp/auth/auth?client_id=X99XKwoHFQsFrmxR&response_type=code&scope=openid%20offline_access&redirect_uri=https%3A%2F%2Fsample.com%2F&
state=e6a7c8b9-0884-4a17-bb51-42728853e958&code_challenge=_RpfHqw8pAZIomzVUE7sjRmHSM543WVdC4o-Kc4_3C0&code_challenge_method=S256
必須項目のみ指定時
例：https://account.e-gov.go.jp/auth/auth?client_id=X99XKwoHFQsFrmxR&response_type=code&scope=openid%20offline_access&redirect_uri=https%3A%2F%2Fsample.com%2F",
"parameters": [
{
"in": "query",
"name": "client_id",
"description": "API対応ソフトウェア開発事業者に発行されるソフトウェアID
・半角英数字",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "response_type",
"description": "レスポンス・タイプ「code」を指定する
・半角英数字",
"required": true,
"schema": {
"type": "string",
"minLength": 4
}
},
{
"in": "query",
"name": "scope",
"description": "スコープ「openid offline_access」を指定する
・半角英数字
例：scope=openid%20offline_access",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "redirect_uri",
"description": "ログイン成功時にリダイレクトするURL
APIキー発行時に指定したリダイレクトするURL（API対応ソフトウェア開発事業者がログイン後に遷移させたいURL）を「URLエンコード」して指定する
・半角英数字",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "state",
"description": "リクエストとコールバックの間で維持されるランダムな値
API対応ソフトウェア開発事業者側で任意に生成して指定する
・半角英数字
・CSRF対策",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "code_challenge",
"description": "API対応ソフトウェア開発事業者側でハッシュ値を生成して指定
ハッシュアルゴリズムは、「SHA-256」とし、ハッシュ値は16進数の値として扱い、「BASE64URLエンコード」して指定する
※BASE64エンコードではないことに注意
ハッシュ値の元となる文字列の制限については「アクセストークン取得」の「code_verifier」を参照
・半角英数字
・43-128桁
・PKCE対策",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "code_challenge_method",
"description": "code_challengeで指定した文字列のハッシュアルゴリズムを指定
ハッシュアルゴリズム「S256」を指定する
・半角英数字
・PKCE対策",
"schema": {
"type": "string"
}
}
],
"responses": {
"302": {
"description": "レスポンスとして、認証画面・同意画面が返される。
認証画面・同意画面においてログイン・承認の操作を行うと、ブラウザにはステータスコード302が返却され、次に指定したリダイレクトURIにリダイレクトされる。"
}
}
}
},
"/(リダイレクト先のURL)": {
"servers": [
{
"url": "https://account.e-gov.go.jp/auth"
}
],
"description": "利用者認証",
"get": {
"tags": [
"利用者認証"
],
"summary": "ユーザー認可(リダイレクトでの認可コード送信):リダイレクト先に認可コードを渡す。",
"description": "※使用者は呼び出しは行わないが、本呼び出しでリダイレクト先に認可コードが渡されることを意識する必要がある。",
"parameters": [
{
"in": "query",
"name": "code",
"description": "認可コード
・半角英数字",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "state",
"description": "ユーザー認可リクエスト時に指定した「state」値
・半角英数字
・リクエスト時に保存していた値をコールバック時の値が一致するかAPI対応ソフトウェア開発事業者で確認する。",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "session_state",
"required": true,
"description": "セッション状態を表す識別子
・半角英数字",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/BadRequest_token"
},
"401": {
"$ref": "#/components/responses/Unauthorized_token"
},
"404": {
"$ref": "#/components/responses/NotFound_token"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed_token"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_token"
},
"500": {
"$ref": "#/components/responses/InternalServerError_token"
}
}
}
},
"/token": {
"servers": [
{
"url": "https://account.e-gov.go.jp/auth"
}
],
"description": "利用者認証",
"post": {
"tags": [
"利用者認証"
],
"summary": "アクセストークン取得/再取得:アクセストークンとリフレッシュトークンを取得/再取得する。",
"description": "ユーザー認可リクエストで返却された認可コードを認可サーバへ送信し、アクセストークンとアクセストークン更新用のリフレッシュトークンを取得する。
アクセストークン取得リクエストで取得したリフレッシュトークンを認可サーバへ送信し、アクセストークンとリフレッシュトークンを再取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type_token"
},
{
"$ref": "#/components/parameters/Authorization_basic"
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/request_token"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/results_token"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest_token"
},
"401": {
"$ref": "#/components/responses/Unauthorized_token"
},
"404": {
"$ref": "#/components/responses/NotFound_token"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed_token"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_token"
},
"500": {
"$ref": "#/components/responses/InternalServerError_token"
}
}
}
},
"/token/introspect": {
"servers": [
{
"url": "https://account.e-gov.go.jp/auth"
}
],
"description": "利用者認証",
"post": {
"tags": [
"利用者認証"
],
"summary": "アクセストークン検証:アクセストークンまたはリフレッシュトークンの有効性を検証する。",
"description": "取得したアクセストークンまたはリフレッシュトークンの有効性を検証し、トークンに関連付けられている情報を取得する。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type_token"
},
{
"$ref": "#/components/parameters/Authorization_basic"
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/request_introspect"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/results_introspect"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest_token"
},
"401": {
"$ref": "#/components/responses/Unauthorized_token"
},
"404": {
"$ref": "#/components/responses/NotFound_token"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed_token"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_token"
},
"500": {
"$ref": "#/components/responses/InternalServerError_token"
}
}
}
},
"/logout": {
"servers": [
{
"url": "https://account.e-gov.go.jp/auth"
}
],
"description": "利用者認証",
"post": {
"tags": [
"利用者認証"
],
"summary": "ログアウト:ログアウトを行う。",
"description": "e-Gov認可サーバとの認証状態を破棄し、ログアウトを行う。取得済みのアクセストークン、リフレッシュトークンが無効化される。",
"parameters": [
{
"$ref": "#/components/parameters/Content-Type_token"
},
{
"$ref": "#/components/parameters/Authorization_basic"
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"required": [
"refresh_token"
],
"properties": {
"refresh_token": {
"description": "アクセストークン取得リクエストで取得したリフレッシュトークン
・半角英数字",
"type": "string"
}
}
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"$ref": "#/components/responses/BadRequest_token"
},
"401": {
"$ref": "#/components/responses/Unauthorized_token"
},
"404": {
"$ref": "#/components/responses/NotFound_token"
},
"405": {
"$ref": "#/components/responses/MethodNotAllowed_token"
},
"413": {
"$ref": "#/components/responses/RequestEntityTooLarge_token"
},
"500": {
"$ref": "#/components/responses/InternalServerError_token"
}
}
}
}
},
"components": {
"parameters": {
"Content-Type": {
"name": "Content-Type",
"in": "header",
"description": "application/jsonを設定
JSON文書",
"required": true,
"schema": {
"type": "string"
}
},
"Content-Type_token": {
"name": "Content-Type",
"in": "header",
"description": "application/x-www-form-urlencodedを設定",
"required": true,
"schema": {
"type": "string",
"minLength": 33
}
},
"Authorization": {
"name": "Authorization",
"in": "header",
"description": "アクセストークン取得リクエストにより取得したアクセストークン
”Bearer アクセストークン”形式で設定",
"required": true,
"schema": {
"type": "string"
}
},
"Authorization_basic": {
"name": "Authorization",
"in": "header",
"description": "Basic [client_id:client_secretをbase64でエンコードした値]
・半角英数字
client_id:API対応ソフトウェア開発事業者に発行されるソフトウェアID
client_secret:API対応ソフトウェア開発事業者に発行されるAPIキー",
"required": true,
"schema": {
"type": "string"
}
},
"X-eGovAPI-Trial": {
"name": "X-eGovAPI-Trial",
"in": "header",
"description": "トライアルでAPIを動作させる場合は\"true\"を設定
指定なしの場合は非トライアルで動作",
"schema": {
"type": "boolean"
}
},
"proc_id": {
"name": "proc_id",
"in": "path",
"description": "手続識別子
・16桁
・半角英数字",
"required": true,
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 16
}
},
"send_number": {
"name": "send_number",
"in": "query",
"description": "送信番号
・半角数字
・18桁
・送信番号で取得する場合のみ指定",
"schema": {
"type": "string",
"minLength": 18,
"maxLength": 18
}
},
"date_from": {
"name": "date_from",
"in": "query",
"description": "取得対象期間開始日
・半角
・10桁
・YYYY-MM-DD
例：2017-09-01",
"required": true,
"schema": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
}
},
"date_to": {
"name": "date_to",
"in": "query",
"description": "取得対象期間終了日
・半角
・10桁
・YYYY-MM-DD
例：2017-09-01",
"required": true,
"schema": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
}
},
"date_from_optional": {
"name": "date_from",
"in": "query",
"description": "取得対象期間開始日
・半角
・10桁
・YYYY-MM-DD
例：2017-09-01
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定",
"schema": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
}
},
"date_to_optional": {
"name": "date_to",
"in": "query",
"description": "取得対象期間終了日
・半角
・10桁
・YYYY-MM-DD
例：2017-09-01
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定",
"schema": {
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
}
},
"limit_50": {
"name": "limit",
"in": "query",
"description": "取得件数
・数字
・1-2桁
・上限値50",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 50
}
},
"limit_30": {
"name": "limit",
"in": "query",
"description": "取得件数
・数字
・1-2桁
・上限値30",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 30
}
},
"limit_50_optional": {
"name": "limit",
"in": "query",
"description": "取得件数
・数字
・1-2桁
・上限値50
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 50
}
},
"limit_30_optional": {
"name": "limit",
"in": "query",
"description": "取得件数
・数字
・1-2桁
・上限値30
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 30
}
},
"offset": {
"name": "offset",
"in": "query",
"description": "取得ページ番号
・数字
・1-4桁",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
}
},
"offset_optional": {
"name": "offset",
"in": "query",
"description": "取得ページ番号
・数字
・1-4桁
・対象期間及び取得件数/ページオフセット件数で取得する場合のみ指定",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
}
},
"information_id": {
"name": "information_id",
"in": "path",
"required": true,
"description": "お知らせID
・半角英数字
・1-16桁",
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 16
}
},
"arrive_id": {
"name": "arrive_id",
"in": "path",
"required": true,
"description": "到達番号
・半角数字
・16-18桁",
"schema": {
"type": "string",
"minLength": 16,
"maxLength": 18
}
},
"notice_sub_id": {
"name": "notice_sub_id",
"in": "path",
"required": true,
"description": "通知通番
・数字
・1-3桁",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999
}
},
"X-eGovAPI-Trial-NON": {
"name": "X-eGovAPI-Trial",
"in": "header",
"description": "トライアルでAPIを動作させる場合は\"true\"を設定
指定なしの場合は非トライアルで動作
※電子送達はトライアル非対応のため、設定を行ってもトライアルにはなりません。",
"schema": {
"type": "boolean"
}
},
"X-eGovAPI-Trial-NON-share": {
"name": "X-eGovAPI-Trial",
"in": "header",
"description": "トライアルでAPIを動作させる場合は\"true\"を設定
指定なしの場合は非トライアルで動作
※アカウント間情報共有はトライアル非対応のため、設定を行ってもトライアルにはなりません。",
"schema": {
"type": "boolean"
}
},
"post_id": {
"name": "post_id",
"in": "path",
"required": true,
"description": "電子送達識別子
・半角英数字
・1-50桁",
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50
}
}
},
"responses": {
"BadRequest": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Bad Request",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "リクエスト内容に問題あり",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメント",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
}
}
}
}
}
},
"BadRequest_Report": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Bad Request",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "リクエスト内容に問題あり",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list"
}
]
}
}
}
}
}
},
"BadRequest_Report_withdraw": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Bad Request",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "リクエスト内容に問題あり",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list_withdraw"
}
]
}
}
}
}
}
},
"BadRequest_error": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance",
"error_count"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Bad Request",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "リクエスト内容に問題あり",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"error_count": {
"description": "エラー件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/error_bulk"
}
]
}
}
}
}
}
},
"BadRequest_token": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_token"
}
]
}
}
}
},
"Unauthorized": {
"description": "Unauthorized",
"headers": {
"WWW-authenticate": {
"schema": {
"type": "string"
},
"description": "未認証時に返却(RFC7235に準拠)、文字コードISO-8859-1でレスポンスされる。
・realm: レルム名、必須
・error: エラー種別（invalid_request, invalid_token, insufficient_scope）
・error_description: エラー詳細"
}
}
},
"Unauthorized_token": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_token"
}
]
}
}
}
},
"NotFound": {
"description": "Not Found
HTTPステータスのみ返却"
},
"NotFound_token": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_token"
}
]
}
}
}
},
"InternalServerError": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Internal Server Error",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "サーバ内部でエラーが発生（システムエラー等）",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
}
}
}
}
}
},
"InternalServerError_Report": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Internal Server Error",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "サーバ内部でエラーが発生（システムエラー等）",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list"
}
]
}
}
}
}
}
},
"InternalServerError_Report_withdraw": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Internal Server Error",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "サーバ内部でエラーが発生（システムエラー等）",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list_withdraw"
}
]
}
}
}
}
}
},
"InternalServerError_error": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance",
"error_count"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Internal Server Error",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "サーバ内部でエラーが発生（システムエラー等）",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"error_count": {
"description": "エラー件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
}
}
}
}
}
},
"InternalServerError_token": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_token"
}
]
}
}
}
},
"RequestEntityTooLarge": {
"description": "Request Entity Too Large",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Request Entity Too Large",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "アップロードサイズファイル上限オーバー",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
}
}
}
}
}
},
"RequestEntityTooLarge_Report": {
"description": "Request Entity Too Large",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Request Entity Too Large",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "アップロードサイズファイル上限オーバー",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list"
}
]
}
}
}
}
}
},
"RequestEntityTooLarge_Report_withdraw": {
"description": "Request Entity Too Large",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Request Entity Too Large",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "アップロードサイズファイル上限オーバー",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list_withdraw"
}
]
}
}
}
}
}
},
"RequestEntityTooLarge_error": {
"description": "Request Entity Too Large",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance",
"error_count"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Request Entity Too Large",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "アップロードサイズファイル上限オーバー",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"error_count": {
"description": "エラー件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
}
}
}
}
}
},
"RequestEntityTooLarge_token": {
"description": "Request Entity Too Large",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_token"
}
]
}
}
}
},
"ServiceUnavaiable": {
"description": "Service Unavaiable",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Service Unavaiable",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "サービス利用不可(サーバがメンテナンス中等)",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
}
}
}
}
}
},
"ServiceUnavaiable_Report": {
"description": "Service Unavaiable",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Service Unavaiable",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "サービス利用不可(サーバがメンテナンス中等)",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list"
}
]
}
}
}
}
}
},
"ServiceUnavaiable_Report_withdraw": {
"description": "Service Unavaiable",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Service Unavaiable",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "サービス利用不可(サーバがメンテナンス中等)",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list_withdraw"
}
]
}
}
}
}
}
},
"ServiceUnavaiable_error": {
"description": "Service Unavaiable",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"title",
"type",
"instance",
"error_count"
],
"properties": {
"title": {
"description": "エラー内容
・全半角",
"type": "string",
"example": "Service Unavaiable",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "エラー詳細
・全半角",
"type": "string",
"example": "サービス利用不可(サーバがメンテナンス中等)",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURI
・半角",
"type": "string",
"example": "APIドキュメントURI",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"example": "エンドポイントURI",
"minLength": 1,
"maxLength": 256
},
"error_count": {
"description": "エラー件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
}
}
}
}
}
},
"ServiceUnavaiable_token": {
"description": "Service Unavaiable",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_token"
}
]
}
}
}
},
"MethodNotAllowed_token": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error_token"
}
]
}
}
}
}
},
"schemas": {
"results_procedure": {
"type": "object",
"required": [
"file_data",
"configuration_file_name",
"file_info"
],
"properties": {
"file_data": {
"description": "ファイル圧縮データ
・半角
・構成管理XMLファイル、申請書XMLファイル、スタイルシートファイル、形式チェックファイル、スキーマファイル、様式記入要領ファイル
・バイナリデータはBase64エンコードしたものを使用する
※「ファイル圧縮データ」は、以下の命名規則に従って作成したルートフォルダに申請データファイルを格納し、圧縮したファイルデータとなる。
ルートフォルダの命名規則
手続ID（半角英数字16桁）
ex）9999999999999999
【構造】
ルートフォルダ
├構成管理XML
├構成管理スタイルシート
├構成管理形式チェックファイル
├申請書XML × 様式数
├申請書スタイルシート × 様式数
├申請書形式チェックファイル × 様式数
├構成情報 × 個別署名必要数
├構成情報スタイルシート(個別署名の場合のみ)
└構成情報チェックファイル(個別署名の場合のみ)",
"type": "string",
"format": "byte",
"minLength": 1
},
"configuration_file_name": {
"type": "array",
"items": {
"description": "手続識別子に紐づく構成管理XMLファイル名（または、構成情報XMLファイル名）
・全半角
・構成情報XMLファイル名は申請が個別ファイル署名形式の場合のみ出力。",
"type": "string",
"minLength": 1,
"maxLength": 28
}
},
"file_info": {
"allOf": [
{
"$ref": "#/components/schemas/file_info"
}
]
}
}
},
"file_info": {
"type": "array",
"description": "手続識別子に紐づく様式情報",
"items": {
"type": "object",
"properties": {
"form_id": {
"description": "手続識別子に紐づく様式ID
・半角英数字",
"type": "string",
"minLength": 18,
"maxLength": 18
},
"form_version": {
"description": "手続識別子に紐づく様式バージョン名
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
},
"form_name": {
"description": "手続識別子に紐づく様式名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"apply_file_name": {
"description": "手続識別子に紐づく申請書XMLファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"xsl_file_name": {
"description": "手続識別子に紐づくスタイルシートファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"server_check_file_name": {
"description": "手続識別子に紐づく形式チェックファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"schema_file_name": {
"description": "手続識別子に紐づくスキーマファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"style_indication_file": {
"description": "手続識別子に紐づく様式記入要領ファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"results_preprint": {
"type": "object",
"required": [
"apply_file"
],
"properties": {
"apply_file": {
"description": "プレ印字された申請書XML",
"allOf": [
{
"$ref": "#/components/schemas/data_pre"
}
]
}
}
},
"results_apply": {
"type": "object",
"required": [
"arrive_id",
"arrive_date",
"corporation_name",
"applicant_name",
"apply_type",
"proc_name",
"ministry_name",
"submission_destination",
"apply_form"
],
"properties": {
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"arrive_date": {
"description": "到達日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"corporation_name": {
"description": "法人名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"applicant_name": {
"description": "申請者名
・全角",
"type": "string",
"minLength": 3,
"maxLength": 256
},
"apply_type": {
"description": "申請区分
・全角
・「新規申請」または「再提出」",
"type": "string",
"minLength": 3,
"maxLength": 4
},
"proc_name": {
"description": "手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"ministry_name": {
"description": "府省名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 12
},
"submission_destination": {
"description": "提出先
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"apply_form": {
"allOf": [
{
"$ref": "#/components/schemas/apply_form"
}
]
},
"apply_pay_list": {
"allOf": [
{
"$ref": "#/components/schemas/apply_pay_list_apply"
}
]
}
}
},
"apply_form": {
"description": "申請した各様式・書類の内容",
"type": "object",
"properties": {
"form": {
"allOf": [
{
"$ref": "#/components/schemas/form"
}
]
},
"attached_file": {
"allOf": [
{
"$ref": "#/components/schemas/attached_file"
}
]
}
}
},
"form": {
"description": "様式",
"type": "array",
"items": {
"type": "object",
"properties": {
"form_name": {
"description": "様式名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
}
},
"attached_file": {
"description": "様式",
"type": "array",
"items": {
"type": "object",
"properties": {
"attached_file_name": {
"description": "添付書類名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"apply_pay_list_apply": {
"type": "array",
"description": "納付情報",
"items": {
"type": "object",
"properties": {
"pay_number": {
"description": "納付番号
・半角英数字",
"type": "string",
"minLength": 16,
"maxLength": 16
},
"confirm_number": {
"description": "確認番号
・半角数字",
"type": "string",
"minLength": 6,
"maxLength": 6
},
"facility_number": {
"description": "収納機関番号
・半角英数字",
"type": "string",
"minLength": 5,
"maxLength": 5
},
"pay_name_kana": {
"description": "納付手続名（カナ）
・全角",
"type": "string",
"minLength": 1,
"maxLength": 24
},
"total_fee": {
"description": "払込金額
・数字",
"type": "integer",
"format": "int64",
"minimum": 0,
"maximum": 9223372036854776000
},
"pay_expired": {
"description": "払込期限
・半角
YYYY-MM-DD
例：2017-09-01",
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
}
}
}
},
"results_bulk_apply": {
"type": "object",
"required": [
"send_number",
"send_date",
"file_name",
"apply_count"
],
"properties": {
"send_number": {
"description": "発行した送信番号
・半角数字 ",
"type": "string",
"minLength": 18,
"maxLength": 18
},
"send_date": {
"description": "送信日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"file_name": {
"description": "一括申請データのファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"apply_count": {
"description": "申請件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
}
}
},
"results_apply_amend": {
"type": "object",
"required": [
"arrive_id",
"amend_date"
],
"properties": {
"arrive_id": {
"description": "補正対象の到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"amend_date": {
"description": "補正受付日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
}
}
},
"results_apply_withdraw": {
"type": "object",
"required": [
"arrive_id",
"withdraw_date",
"applicant_name",
"proc_name",
"ministry_name"
],
"properties": {
"arrive_id": {
"description": "取り下げ依頼対象の到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"withdraw_date": {
"description": "取り下げ依頼日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"corporation_name": {
"description": "法人名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"applicant_name": {
"description": "申請者名
・全角",
"type": "string",
"minLength": 3,
"maxLength": 256
},
"proc_name": {
"description": "手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"ministry_name": {
"description": "府省名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 12
},
"submission_destination": {
"description": "提出先
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"results_apply_check": {
"type": "object",
"required": [
"message",
"error_count"
],
"properties": {
"message": {
"description": "処理結果に基づくメッセージ
・全半角",
"type": "string"
},
"error_count": {
"description": "エラーレポート件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list"
}
]
}
}
},
"results_apply_lists": {
"type": "object",
"properties": {
"apply_list": {
"allOf": [
{
"$ref": "#/components/schemas/package_apply_list"
}
]
}
}
},
"package_apply_list": {
"type": "array",
"description": "申請案件一覧情報項目",
"items": {
"type": "object",
"properties": {
"no": {
"description": "項番
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
},
"send_number": {
"description": "送信番号
・半角数字",
"type": "string",
"minLength": 1,
"maxLength": 18
},
"send_date": {
"description": "送信日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 1,
"maxLength": 19
},
"status": {
"description": "現在の申請ステータス
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"arrive_date": {
"description": "到達日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"corporation_name": {
"description": "法人名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"applicant_name": {
"description": "申請者名
・全角",
"type": "string",
"minLength": 3,
"maxLength": 256
},
"proc_name": {
"description": "申請案件の手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"submission_destination": {
"description": "提出先
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"withdraw_flag": {
"description": "取下げ可能フラグ",
"type": "boolean"
},
"pay_status": {
"description": "納付状況
・全角",
"type": "string",
"minLength": 1,
"maxLength": 6
},
"notice_count": {
"description": "通知件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"doc_count": {
"description": "公文書件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"apply_pay_count": {
"description": "納付情報件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"notice_list": {
"allOf": [
{
"$ref": "#/components/schemas/notice_list_apply"
}
]
},
"official_list": {
"allOf": [
{
"$ref": "#/components/schemas/official_list"
}
]
},
"apply_pay_list": {
"allOf": [
{
"$ref": "#/components/schemas/apply_pay_list_apply"
}
]
},
"applied_account": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "提出実施アカウント
・半角"
}
}
}
},
"results_apply_detail": {
"type": "object",
"required": [
"status",
"arrive_id",
"arrive_date",
"corporation_name",
"applicant_name",
"proc_name",
"submission_destination",
"withdraw_flag",
"pay_status",
"notice_count",
"doc_count",
"apply_pay_count"
],
"properties": {
"status": {
"description": "現在の申請ステータス
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"arrive_date": {
"description": "到達日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"corporation_name": {
"description": "法人名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"applicant_name": {
"description": "申請者名
・全角",
"type": "string",
"minLength": 3,
"maxLength": 256
},
"proc_name": {
"description": "申請案件の手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"submission_destination": {
"description": "提出先
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"withdraw_flag": {
"description": "取下げ可能フラグ",
"type": "boolean"
},
"pay_status": {
"description": "納付状況
・全角",
"type": "string",
"minLength": 1,
"maxLength": 6
},
"notice_count": {
"description": "通知件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"doc_count": {
"description": "公文書件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"apply_pay_count": {
"description": "納付情報件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"notice_list": {
"allOf": [
{
"$ref": "#/components/schemas/notice_list_apply"
}
]
},
"official_list": {
"allOf": [
{
"$ref": "#/components/schemas/official_list"
}
]
},
"apply_pay_list": {
"allOf": [
{
"$ref": "#/components/schemas/apply_pay_list_apply"
}
]
},
"applied_account": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "提出実施アカウント
・半角"
}
}
},
"notice_list_apply": {
"type": "array",
"description": "申請案件に関する通知",
"items": {
"type": "object",
"properties": {
"notice_sub_id": {
"description": "通知通番
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999
},
"issue_date": {
"description": "発行日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"notice_data_type": {
"description": "種別
・全角
補正通知も含む",
"type": "string",
"minLength": 2,
"maxLength": 4
},
"notice_title": {
"description": "件名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"notice_sentence": {
"description": "本文
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 512
},
"issuer_organization": {
"description": "発出元
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"correct_expired_date": {
"description": "補正期限年月日
・半角
・YYYY-MM-DD
例：2017-09-01",
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
},
"correct_completed_date": {
"description": "補正日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"format": "date",
"minLength": 19,
"maxLength": 19
}
}
}
},
"official_list": {
"type": "array",
"description": "取得要求した申請案件の公文書
公文書が発行された申請案件のみ",
"items": {
"type": "object",
"properties": {
"notice_sub_id": {
"description": "通知通番
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999
},
"allowed_date": {
"description": "発行日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"doc_title": {
"description": "件名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"doc_download_expired_date": {
"description": "取得期限
・半角
・YYYY-MM-DD
例：2017-09-01",
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
},
"doc_download_date": {
"description": "取得完了日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"format": "date",
"minLength": 19,
"maxLength": 19
},
"sign": {
"description": "署名有無
・全角
あり／なし",
"type": "string",
"minLength": 2,
"maxLength": 2
}
}
}
},
"results_apply_report": {
"type": "object",
"properties": {
"error_report_info": {
"allOf": [
{
"$ref": "#/components/schemas/error_report_info"
}
]
}
}
},
"error_report_info": {
"type": "array",
"description": "エラーレポート情報
送信日時の降順でソート
要素の上限回数はシステム設定値",
"items": {
"type": "object",
"properties": {
"send_number": {
"description": "発行した送信番号
・半角数字 ",
"type": "string",
"minLength": 18,
"maxLength": 18
},
"send_date": {
"description": "送信日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"file_name": {
"description": "一括申請データのファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"apply_count": {
"description": "一括申請データに含まれていた申請件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
},
"arrive_count": {
"description": "到達した申請件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
},
"error_count": {
"description": "エラーとなった申請件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/result_report_info_result"
}
]
}
}
}
},
"result_report_info_result": {
"type": "array",
"description": "申請結果・エラーの内容
申請フォルダ名の昇順でソート",
"items": {
"type": "object",
"properties": {
"arrive_id": {
"description": "到達番号
・半角数字
エラーが発生して到達されていない場合は”-”",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"arrive_date": {
"description": "到達日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00
エラーが発生して到達されていない場合は”-”",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"proc_name": {
"description": "手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"folder_name": {
"description": "一括申請データ内の申請フォルダ名
・半角英数字",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"report_list": {
"allOf": [
{
"$ref": "#/components/schemas/report_list"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"description": "エラー詳細
・全半角",
"type": "string"
}
}
}
}
]
}
}
}
},
"results_message_lists": {
"type": "object",
"properties": {
"information_list": {
"allOf": [
{
"$ref": "#/components/schemas/message_list"
}
]
}
}
},
"message_list": {
"type": "array",
"description": "手続に関するご案内一覧
※発出日時の降順でソート
要素の上限回数はシステム設定値",
"items": {
"type": "object",
"properties": {
"information_id": {
"description": "お知らせID
・半角英数字",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"issuer_organization": {
"description": "発出元
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"issue_date": {
"description": "発出日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"proc_first_category": {
"description": "手続分野大分類
・全角",
"type": "string",
"minLength": 1,
"maxLength": 400
},
"proc_second_category": {
"description": "手続分野中分類
・全角",
"type": "string",
"minLength": 1,
"maxLength": 400
},
"proc_third_category": {
"description": "手続分野小分類
・全角",
"type": "string",
"minLength": 1,
"maxLength": 400
},
"information_title": {
"description": "タイトル
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"results_message": {
"type": "object",
"required": [
"information"
],
"properties": {
"information": {
"description": "手続に関するご案内",
"allOf": [
{
"$ref": "#/components/schemas/message"
}
]
}
}
},
"message": {
"type": "object",
"required": [
"issuer_organization",
"issue_date",
"proc_first_category",
"proc_second_category",
"proc_third_category",
"information_title",
"information_data"
],
"properties": {
"issuer_organization": {
"description": "発出元
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"issue_date": {
"description": "発出日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"proc_first_category": {
"description": "手続分野大分類
・全角",
"type": "string",
"minLength": 1,
"maxLength": 400
},
"proc_second_category": {
"description": "手続分野中分類
・全角",
"type": "string",
"minLength": 1,
"maxLength": 400
},
"proc_third_category": {
"description": "手続分野小分類
・全角",
"type": "string",
"minLength": 1,
"maxLength": 400
},
"information_title": {
"description": "タイトル
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"information_data": {
"description": "本文
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"attached_file_list": {
"description": "添付ファイルリスト",
"allOf": [
{
"$ref": "#/components/schemas/data_optional"
}
]
}
}
},
"results_notice_lists": {
"type": "object",
"properties": {
"notice_list": {
"allOf": [
{
"$ref": "#/components/schemas/notice_list"
}
]
}
}
},
"notice_list": {
"type": "array",
"description": "申請案件に関する通知一覧
※発出日時の降順でソート
要素の上限回数はシステム設定値",
"items": {
"type": "object",
"properties": {
"issuer_organization": {
"description": "発出元
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"notice_sub_id": {
"description": "通知通番
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999
},
"notice_issue_date": {
"description": "通知発行日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"type": {
"description": "種別
・全角",
"type": "string",
"minLength": 2,
"maxLength": 4
},
"title": {
"description": "タイトル
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"corporation_name_list": {
"allOf": [
{
"$ref": "#/components/schemas/corporation_name_list"
}
]
},
"applicant_name_list": {
"allOf": [
{
"$ref": "#/components/schemas/applicant_name_list"
}
]
},
"proc_name": {
"description": "手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"notified_account": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "通知対象アカウント
・半角"
}
}
}
},
"corporation_name_list": {
"description": "法人名リスト",
"type": "array",
"items": {
"type": "object",
"properties": {
"corporation_name": {
"description": "法人名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"applicant_name_list": {
"description": "申請者名リスト",
"type": "array",
"items": {
"type": "object",
"properties": {
"applicant_name": {
"description": "申請者名
・全角",
"type": "string",
"minLength": 3,
"maxLength": 256
}
}
}
},
"results_notice": {
"type": "object",
"required": [
"notice"
],
"properties": {
"notice": {
"allOf": [
{
"$ref": "#/components/schemas/notice"
}
]
}
}
},
"notice": {
"type": "object",
"description": "申請案件に関する通知",
"required": [
"issuer_organization",
"notice_issue_date",
"notice_title",
"proc_name"
],
"properties": {
"issuer_organization": {
"description": "発出元
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"notice_issue_date": {
"description": "通知発行日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"notice_type": {
"description": "種別
・全角
お知らせ、納付、補正、取下げ",
"type": "string",
"minLength": 2,
"maxLength": 4
},
"correct_type": {
"description": "補正種別
※種別が\"補正\"の場合のみ以下を出力
部分補正、再提出、手続終了(再提出可)
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 10
},
"correct_expired_date": {
"description": "補正期限年月日
※種別が\"補正\"の場合のみ出力
・半角
・YYYY-MM-DD
例：2017-09-01",
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
},
"correct_completed_date": {
"description": "補正完了日時
※種別が\"補正\"の場合かつ既に補正を行っている場合のみ出力
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"format": "date",
"minLength": 19,
"maxLength": 19
},
"notice_title": {
"description": "タイトル
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"notice_sentence": {
"description": "本文
・全角",
"type": "string",
"minLength": 1,
"maxLength": 512
},
"attached_file_list": {
"description": "添付ファイルリスト",
"allOf": [
{
"$ref": "#/components/schemas/data_optional"
}
]
},
"corporation_name_list": {
"allOf": [
{
"$ref": "#/components/schemas/corporation_name_list"
}
]
},
"applicant_name_list": {
"allOf": [
{
"$ref": "#/components/schemas/applicant_name_list"
}
]
},
"proc_name": {
"description": "手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"notified_account": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "通知対象アカウント
・半角"
}
}
},
"results_official_document": {
"type": "object",
"required": [
"file_data",
"file_name_list"
],
"properties": {
"file_data": {
"description": "ファイル圧縮データ
・半角
・鑑ファイル、添付ファイル
・バイナリデータはBase64エンコードしたものを使用する。",
"type": "string",
"format": "byte",
"minLength": 1
},
"file_name_list": {
"description": "ファイル圧縮データに含まれている公文書のファイル名のリスト",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/file_name_list_official"
}
]
}
}
}
},
"file_name_list_official": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"description": "ファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"results_official_document_complete": {
"type": "object",
"required": [
"arrive_id",
"notice_sub_id",
"proc_name",
"doc_title",
"download_date",
"file_name_list"
],
"properties": {
"arrive_id": {
"description": "取得完了要求した到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"notice_sub_id": {
"description": "取得完了要求した通知通番
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999
},
"proc_name": {
"description": "取得完了要求した公文書の手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"doc_title": {
"description": "取得完了要求した公文書の件名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"download_date": {
"description": "取得完了要求した公文書の取得日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"file_name_list": {
"description": "取得完了要求した公文書のファイル名リスト",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/file_name_list"
}
]
}
}
}
},
"file_name_list": {
"type": "object",
"required": [
"file_name"
],
"properties": {
"file_name": {
"description": "取得完了要求した公文書のファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"results_official_document_verify": {
"type": "object",
"required": [
"sig_verification_xml_file_name",
"verify_result"
],
"properties": {
"sig_verification_xml_file_name": {
"description": "署名検証XMLファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"attached_file_name": {
"description": "署名検証対象の添付ファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"verify_result": {
"allOf": [
{
"$ref": "#/components/schemas/verify_result"
}
]
}
}
},
"verify_result": {
"description": "検証結果",
"type": "array",
"items": {
"type": "object",
"properties": {
"official": {
"description": "官職証明書検証結果項目
官職証明書の検証が行われた場合に表示",
"allOf": [
{
"$ref": "#/components/schemas/official"
}
]
},
"government": {
"allOf": [
{
"$ref": "#/components/schemas/government"
}
]
}
}
}
},
"official": {
"type": "object",
"properties": {
"validation_result": {
"description": "署名検証結果
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"certificate_result": {
"description": "証明書検証結果
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"certificate_count": {
"description": "証明書件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 999
},
"publisher": {
"description": "発行者
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"owner": {
"description": "所有者
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"publisher_dn": {
"description": "発行者[DN]
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"owner_dn": {
"description": "所有者[DN]
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"serial_number": {
"description": "シリアルナンバー
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"start_date": {
"description": "有効期間開始日時
・・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00'",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"end_date": {
"description": "有効期間終了日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
}
}
},
"government": {
"type": "array",
"description": "行政機関証明書検証結果
行政機関証明書書の検証が行われた場合に表示",
"items": {
"type": "object",
"properties": {
"publisher_dn": {
"description": "発行者[DN]
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"owner_dn": {
"description": "所有者[DN]
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"serial_number": {
"description": "シリアルナンバー
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"start_date": {
"description": "有効期間開始日時
・・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00'",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"end_date": {
"description": "有効期間終了日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
}
}
}
},
"results_payment_lists": {
"type": "object",
"required": [
"bank_list",
"financial_type_list_date"
],
"properties": {
"bank_list": {
"allOf": [
{
"$ref": "#/components/schemas/bank_list"
}
]
},
"financial_type_list_date": {
"description": "金融機関種別一覧情報日時
・半角
YYYY-MM-DD
例：2017-09-01",
"type": "string",
"minLength": 10,
"maxLength": 10
}
}
},
"bank_list": {
"type": "object",
"description": "金融機関リスト",
"required": [
"trust_bank",
"shinkin_bank",
"credit_union",
"norinchukin_bank",
"labour_bank"
],
"properties": {
"trust_bank": {
"allOf": [
{
"$ref": "#/components/schemas/trust_bank"
}
]
},
"shinkin_bank": {
"description": "信用金庫情報項目",
"allOf": [
{
"$ref": "#/components/schemas/bank_common"
}
]
},
"credit_union": {
"description": "信用組合情報項目",
"allOf": [
{
"$ref": "#/components/schemas/bank_common"
}
]
},
"norinchukin_bank": {
"description": "農林中央金庫情報項目",
"allOf": [
{
"$ref": "#/components/schemas/bank_common"
}
]
},
"labour_bank": {
"description": "労働金庫情報項目",
"allOf": [
{
"$ref": "#/components/schemas/bank_common"
}
]
}
}
},
"trust_bank": {
"description": "銀行・信託銀行一覧項目",
"type": "array",
"items": {
"type": "object",
"properties": {
"initial_name": {
"description": "頭文字
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 1
},
"bank": {
"allOf": [
{
"$ref": "#/components/schemas/bank_trust"
}
]
}
}
}
},
"bank_trust": {
"description": "金融機関情報",
"type": "array",
"items": {
"type": "object",
"properties": {
"financial_name": {
"description": "金融機関名称
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"service_name": {
"description": "ネットバンク商品名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"url": {
"description": "URL
・半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"bank_common": {
"type": "object",
"properties": {
"bank": {
"allOf": [
{
"$ref": "#/components/schemas/bank"
}
]
}
}
},
"bank": {
"description": "金融機関情報",
"type": "array",
"items": {
"type": "object",
"properties": {
"financial_name": {
"description": "金融機関名称
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"url": {
"description": "URL
・半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"results_payment": {
"type": "object",
"required": [
"arrive_id",
"proc_name"
],
"properties": {
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"proc_name": {
"description": "手続名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"apply_pay_list": {
"allOf": [
{
"$ref": "#/components/schemas/apply_pay_list_payment"
}
]
}
}
},
"apply_pay_list_payment": {
"type": "array",
"description": "納付情報",
"items": {
"type": "object",
"properties": {
"pay_number": {
"description": "納付番号
・半角英数字",
"type": "string",
"minLength": 16,
"maxLength": 16
},
"confirm_number": {
"description": "確認番号
・半角数字",
"type": "string",
"minLength": 6,
"maxLength": 6
},
"facility_number": {
"description": "収納機関番号
・半角英数字",
"type": "string",
"minLength": 5,
"maxLength": 5
},
"pay_name_kana": {
"description": "納付手続名（カナ）
・全角",
"type": "string",
"minLength": 1,
"maxLength": 24
},
"pay_expired": {
"description": "払込期限
・半角
YYYY-MM-DD
例：2017-09-01",
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
},
"total_fee": {
"description": "払込金額
・半角数字",
"type": "integer",
"format": "int64",
"minimum": 0,
"maximum": 9223372036854776000
},
"pay_status": {
"description": "納付状況
・全角",
"type": "string",
"minLength": 1,
"maxLength": 6
},
"pay_date": {
"description": "納付日
・半角
YYYY-MM-DD
例：2017-09-01",
"type": "string",
"format": "date",
"minLength": 10,
"maxLength": 10
},
"pay_memo": {
"description": "通信欄
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"pay_flag": {
"description": "納付フラグ
・半角英数字",
"type": "string",
"minLength": 1,
"maxLength": 1
}
}
}
},
"results_payment_site": {
"type": "object",
"required": [
"URL",
"facility_number",
"treasury_money_code",
"parameter_tag_name",
"information_link_data"
],
"properties": {
"URL": {
"description": "URL
・半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"facility_number": {
"description": "収納機関番号
・半角英数字",
"type": "string",
"minLength": 5,
"maxLength": 5
},
"treasury_money_code": {
"description": "国庫金コード
・半角",
"type": "string",
"minLength": 1,
"maxLength": 1
},
"parameter_tag_name": {
"description": "パラメータタグ名
・半角英数字",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"information_link_data": {
"description": "情報リンクデータ
・半角
・バイナリデータはBase64エンコードしたものを使用する。",
"type": "string",
"format": "byte",
"minLength": 1
}
}
},
"request_introspect": {
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"description": "アクセストークン取得リクエストで取得したアクセストークンまたはリフレッシュトークン
・半角英数字",
"type": "string"
},
"token_type_hint": {
"description": "「access_token」または「refresh_token」
・半角英数字
",
"type": "string",
"minLength": 12,
"maxLength": 13
}
}
},
"results_introspect": {
"type": "object",
"required": [
"active"
],
"properties": {
"exp": {
"description": "トークンの有効期限が切れる時のUNIXタイム・スタンプ
・数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "integer",
"format": "int32"
},
"iat": {
"description": "トークンが付与された時のUNIXタイム・スタンプ
・数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "integer",
"format": "int32"
},
"auth_time": {
"description": "ユーザーが認証された時のUNIXタイム・スタンプ
・数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却
※リフレッシュトークン指定時は返却しない",
"type": "integer",
"format": "int32"
},
"jti": {
"description": "トークンの識別子
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"iss": {
"description": "トークンの発行者
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"aud": {
"description": "トークン発行対象の識別子
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"sub": {
"description": "ユーザーの識別子
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"typ": {
"description": "トークンのタイプ
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"azp": {
"description": "認可対象の識別子
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"session_state": {
"description": "セッション状態を表す識別子
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"email": {
"description": "ユーザーのメールアドレス
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却
※リフレッシュトークン指定時は返却しない",
"type": "string"
},
"email_verified": {
"description": "emailアドレスの確認有無
・半角英字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却
※リフレッシュトークン指定時は返却しない",
"type": "boolean"
},
"acr": {
"description": "認証コンテキストのクラス
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却
※リフレッシュトークン指定時は返却しない",
"type": "string"
},
"scope": {
"description": "アクセストークンの有効範囲
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"sid": {
"description": "セッション状態を表す識別子
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"egov_idp": {
"description": "アイデンティティプロバイダの識別子
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却
※リフレッシュトークン指定時は返却しない",
"type": "string"
},
"egov_extidp_auth_time": {
"description": "ユーザーが認証された時のUNIXタイム・スタンプ（ミリ秒）
・数字
外部IDPアカウント（GビズIDアカウント）の場合かつトークンが有効の場合のみ、RFC7662に準拠したパラメータを返却
※リフレッシュトークン指定時は返却しない",
"type": "integer",
"format": "int64"
},
"egov_gbizid_account_type": {
"description": "GビズIDのアカウント種別（1:gbizエントリー、2:gbizプライム、3:gbizメンバー）
・半角数字
外部IDPアカウント（GビズIDアカウント）の場合かつトークンが有効の場合のみ、RFC7662に準拠したパラメータを返却
※リフレッシュトークン指定時は返却しない",
"type": "string"
},
"client_id": {
"description": "トークンの付与先のクライアント
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"username": {
"description": "トークンを付与したユーザーのユーザー名
・半角英数字
トークンが有効の場合のみ、RFC7662に準拠したパラメータを返却",
"type": "string"
},
"active": {
"description": "トークンの有効性
・半角英字",
"type": "boolean"
}
}
},
"request_token": {
"type": "object",
"required": [
"grant_type",
"code",
"redirect_uri",
"refresh_token",
"scope"
],
"properties": {
"grant_type": {
"description": "取得時「authorization_code」固定
再取得時「refresh_token」固定
・半角英数字",
"type": "string",
"minLength": 13,
"maxLength": 18
},
"code": {
"description": "ユーザー認可リクエストで取得済の認可コード
※取得時のみ指定
・半角英数字",
"type": "string"
},
"redirect_uri": {
"description": "ユーザー認可リクエストで指定した「redirect_uri」
※取得時のみ指定
・半角英数字",
"type": "string"
},
"code_verifier": {
"description": "ユーザー認可リクエストで指定した「code_challenge」のハッシュ値の元となった文字列を指定
※取得時のみ指定
・半角英数字
・PKCE対策",
"type": "string",
"minLength": 43,
"maxLength": 128
},
"refresh_token": {
"description": "アクセストークン取得リクエストで取得したリフレッシュトークン
※再取得時のみ指定
・半角英数字",
"type": "string"
}
}
},
"results_token": {
"type": "object",
"required": [
"access_token",
"expires_in",
"refresh_expires_in",
"refresh_token",
"token_type",
"scope",
"id_token",
"not-before-policy",
"session_state"
],
"properties": {
"access_token": {
"description": "アクセストークン
・半角英数字",
"type": "string"
},
"expires_in": {
"description": "アクセストークンの有効期限（秒）
・数字",
"type": "integer",
"format": "int32"
},
"refresh_expires_in": {
"description": "リフレッシュトークンの有効期限（秒）
・数字",
"type": "integer",
"format": "int32"
},
"refresh_token": {
"description": "リフレッシュトークン
・半角英数字",
"type": "string"
},
"token_type": {
"description": "トークン・タイプ
・半角英数字
「Bearer」固定",
"type": "string",
"minLength": 6,
"maxLength": 6
},
"id_token": {
"description": "IDトークン
・半角英数字",
"type": "string"
},
"not-before-policy": {
"description": "アクセスが有効となる日時（UNIXタイム・スタンプ）
・数字",
"type": "integer",
"format": "int32"
},
"session_state": {
"description": "セッション状態を表す識別子
・半角英数字",
"type": "string"
},
"scope": {
"description": "ユーザ認可リクエストで指定したscope
・半角英数字",
"type": "string"
}
}
},
"report_list": {
"description": "エラーレポート一覧",
"type": "array",
"items": {
"type": "object",
"properties": {
"form_name": {
"description": "様式名
・全角
・エラー内容が様式に依らない場合は”-”",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"attached_file_name": {
"description": "添付書類名
・全半角
・エラー内容が添付書類に依らない場合は”-”",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"file_name": {
"description": "ファイル名
・全半角
・エラー内容がファイルに依らない場合は”-”
・構成管理xmlのファイル名を設定",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"item": {
"description": "項目名
・全半角
・エラー内容が項目に依らない場合は”-”
・様式の項目名を設定",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"content": {
"description": "エラー内容
・全半角",
"type": "string"
}
}
}
},
"report_list_withdraw": {
"description": "エラーレポート一覧",
"type": "array",
"items": {
"type": "object",
"properties": {
"file_name": {
"description": "ファイル名
・全半角
・エラー内容がファイルに依らない場合は”-”
・構成管理xmlのファイル名を設定",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"item": {
"description": "項目名
・全半角
・エラー内容が項目に依らない場合は”-”
・様式の項目名を設定",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"content": {
"description": "エラー内容
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"application_info": {
"description": "申請届出識別情報
繰り返し回数1～10",
"type": "array",
"items": {
"type": "object",
"required": [
"label",
"value"
],
"properties": {
"label": {
"description": "入力項目名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 32
},
"value": {
"description": "入力値
・全半角",
"type": "string",
"format": "byte",
"minLength": 1,
"maxLength": 256
}
}
}
},
"metadata_common": {
"required": [
"title",
"detail",
"type",
"instance"
],
"properties": {
"title": {
"description": "API名称
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"detail": {
"description": "詳細情報
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"type": {
"description": "APIドキュメントURL
・半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"instance": {
"description": "エンドポイントURI
・半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
},
"result_set": {
"type": "object",
"description": "結果セット",
"required": [
"all_count",
"limit",
"offset",
"count"
],
"properties": {
"all_count": {
"description": "全件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"limit": {
"description": "取得件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 9999
},
"offset": {
"description": "オフセット件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"count": {
"description": "取得結果件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
}
}
},
"data": {
"type": "object",
"required": [
"file_name",
"file_data"
],
"properties": {
"file_name": {
"description": "ファイル名
拡張子「.zip」も含めて設定
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"file_data": {
"description": "ファイルデータ
・半角
・バイナリデータはBase64エンコードしたものを使用する。",
"type": "string",
"format": "byte",
"minLength": 1
}
}
},
"data_pre": {
"type": "object",
"required": [
"file_name",
"file_data"
],
"properties": {
"file_name": {
"description": "ファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"file_data": {
"description": "ファイルデータ
・半角
・バイナリデータはBase64エンコードしたものを使用する。",
"type": "string",
"format": "byte",
"minLength": 1
}
}
},
"data_optional": {
"type": "array",
"items": {
"type": "object",
"properties": {
"file_name": {
"description": "ファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"file_data": {
"description": "ファイルデータ
・半角
・バイナリデータはBase64エンコードしたものを使用する。",
"type": "string",
"format": "byte",
"minLength": 1
}
}
}
},
"links_lists": {
"type": "object",
"description": "接続URL情報",
"required": [
"self"
],
"properties": {
"self": {
"description": "接続URL情報(自身)
・半角",
"type": "string",
"minLength": 1
},
"previous": {
"description": "接続URL情報（前頁）
・半角",
"type": "string",
"minLength": 1
},
"next": {
"description": "接続URL情報（次頁）
・半角",
"type": "string",
"minLength": 1
}
}
},
"links_lists_note": {
"type": "object",
"description": "接続URL情報",
"required": [
"self"
],
"properties": {
"self": {
"description": "接続URL情報(自身)
・半角",
"type": "string",
"minLength": 1
},
"previous": {
"description": "接続URL情報（前頁）
・半角
・送信番号指定の場合、出力しない
・前頁が存在しない場合、出力しない",
"type": "string",
"minLength": 1
},
"next": {
"description": "接続URL情報（次頁）
・半角
・送信番号指定の場合、出力しない
・次頁が存在しない場合、出力しない",
"type": "string",
"minLength": 1
}
}
},
"links_apply": {
"type": "object",
"description": "接続URL情報",
"required": [
"self",
"status"
],
"properties": {
"self": {
"description": "接続URL情報(自身)
・半角",
"type": "string",
"minLength": 1
},
"status": {
"description": "接続URL情報(申請案件取得)
・半角",
"type": "string",
"minLength": 1
}
}
},
"links_bulk_apply": {
"type": "object",
"description": "接続URL情報",
"required": [
"self",
"list",
"report"
],
"properties": {
"self": {
"description": "接続URL情報(自身)
・半角",
"type": "string",
"minLength": 1
},
"list": {
"description": "接続URL情報（申請案件一覧）
・半角",
"type": "string",
"minLength": 1
},
"report": {
"description": "接続URL情報（エラーレポート）
・半角",
"type": "string",
"minLength": 1
}
}
},
"links_official_document": {
"type": "object",
"description": "接続URL情報",
"required": [
"self",
"complete"
],
"properties": {
"self": {
"description": "接続URL情報(自身)
・半角",
"type": "string",
"minLength": 1
},
"complete": {
"description": "接続URL情報(取得完了)
・半角",
"type": "string",
"minLength": 1
}
}
},
"error_token": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"description": "HTTPステータスに紐づくエラーコード
・半角英数字",
"type": "string"
},
"error_description": {
"description": "エラーコードに紐づくエラー詳細
・全角",
"type": "string"
}
}
},
"error_bulk": {
"type": "array",
"description": "エラー内容項目",
"items": {
"type": "object",
"required": [
"self",
"complete"
],
"properties": {
"errorFolder": {
"description": "エラー申請フォルダ名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"errorFile": {
"description": "エラー申請ファイル名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"content": {
"description": "エラー内容
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
},
"results_post_apply": {
"type": "object",
"required": [
"arrive_id",
"arrive_date",
"corporation_name",
"applicant_name",
"apply_type",
"proc_name",
"ministry_name",
"submission_destination",
"apply_form",
"apply_pay_list"
],
"properties": {
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"arrive_date": {
"description": "到達日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"corporation_name": {
"description": "法人名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"applicant_name": {
"description": "申込者名
・全角",
"type": "string",
"minLength": 3,
"maxLength": 256
},
"apply_type": {
"description": "申請区分
・全角
・「新規申請」または「再提出」",
"type": "string",
"minLength": 3,
"maxLength": 4
},
"proc_name": {
"description": "利用申込み対象の名称
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"ministry_name": {
"description": "申込み所管府省
・全角",
"type": "string",
"minLength": 1,
"maxLength": 12
},
"submission_destination": {
"description": "提出先
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"apply_form": {
"allOf": [
{
"$ref": "#/components/schemas/post_apply_form"
}
]
},
"apply_pay_list": {
"allOf": [
{
"$ref": "#/components/schemas/apply_pay_list_apply"
}
]
}
}
},
"post_apply_form": {
"description": "申込みを行った各様式・書類の内容",
"type": "object",
"properties": {
"form": {
"allOf": [
{
"$ref": "#/components/schemas/form"
}
]
},
"attached_file": {
"allOf": [
{
"$ref": "#/components/schemas/attached_file"
}
]
}
}
},
"results_post_apply_detail": {
"type": "object",
"required": [
"status",
"arrive_id",
"arrive_date",
"corporation_name",
"applicant_name",
"proc_name",
"submission_destination",
"withdraw_flag",
"pay_status",
"notice_count",
"doc_count",
"apply_pay_count"
],
"properties": {
"status": {
"description": "現在の申請ステータス
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"arrive_id": {
"description": "到達番号
・半角数字",
"type": "string",
"minLength": 16,
"maxLength": 18
},
"arrive_date": {
"description": "到達日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"corporation_name": {
"description": "法人名
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"applicant_name": {
"description": "申込者名
・全角",
"type": "string",
"minLength": 3,
"maxLength": 256
},
"proc_name": {
"description": "申込対象の名称
・全角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"submission_destination": {
"description": "提出先
・全角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"withdraw_flag": {
"description": "取下げ可能フラグ",
"type": "boolean"
},
"pay_status": {
"description": "納付状況
・全角",
"type": "string",
"minLength": 1,
"maxLength": 6
},
"notice_count": {
"description": "通知件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"doc_count": {
"description": "公文書件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"apply_pay_count": {
"description": "納付情報件数
・数字",
"type": "integer",
"format": "int32",
"minimum": 0,
"maximum": 9999
},
"notice_list": {
"allOf": [
{
"$ref": "#/components/schemas/notice_list_apply"
}
]
},
"official_list": {
"allOf": [
{
"$ref": "#/components/schemas/official_list"
}
]
},
"apply_pay_list": {
"allOf": [
{
"$ref": "#/components/schemas/apply_pay_list_apply"
}
]
},
"applied_account": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"description": "提出実施アカウント
・半角"
}
}
},
"results_post": {
"type": "object",
"required": [
"notice_data_name",
"file_data",
"file_name_list"
],
"properties": {
"notice_data_name": {
"description": "取得した通知文書一式の名称
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"file_data": {
"description": "ファイル圧縮データ
・半角
・鑑ファイル、添付ファイル
・バイナリデータはBase64エンコードしたものを使用する。",
"type": "string",
"format": "byte",
"minLength": 1
},
"file_name_list": {
"description": "ファイル圧縮データに含まれている通知文書のファイル名のリスト",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/file_name_list_official"
}
]
}
}
}
},
"results_post_complete": {
"type": "object",
"required": [
"post_id",
"notice_data_name",
"download_date"
],
"properties": {
"post_id": {
"description": "取得完了要求した電子送達識別子
・半角英数字
・1-50桁",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"notice_data_name": {
"description": "取得完了要求した通知文書一式の名称
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"download_date": {
"description": "取得完了要求した通知文書の取得日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
}
}
},
"results_post_lists": {
"type": "object",
"required": [
"post_list"
],
"properties": {
"post_list": {
"allOf": [
{
"$ref": "#/components/schemas/post_list"
}
]
}
}
},
"post_list": {
"type": "array",
"description": "電子送達一覧
※発出日時の降順でソート
要素の上限回数はシステム設定値",
"items": {
"type": "object",
"properties": {
"ministry_message_id": {
"description": "府省メッセージ通番
・半角英数字",
"type": "string",
"minLength": 1,
"maxLength": 18
},
"type": {
"description": "種別
・全角",
"type": "string",
"minLength": 2,
"maxLength": 4
},
"title": {
"description": "タイトル
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"message_sentence": {
"description": "本文
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"issuer_organization": {
"description": "発出元
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"issue_date": {
"description": "発出日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"received_account": {
"description": "送達対象アカウント
・半角英数字",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"notice_data_list": {
"allOf": [
{
"$ref": "#/components/schemas/notice_data_list"
}
]
}
}
}
},
"notice_data_list": {
"description": "通知文書リスト",
"type": "array",
"items": {
"type": "object",
"properties": {
"post_id": {
"description": "電子送達識別子
・半角英数字
・1-50桁",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"notice_data_name": {
"description": "通知文書名
・全半角",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"notice_issue_date": {
"description": "通知文書の発出日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"download_expired_date": {
"description": "通知文書の取得期限
・半角
・YYYY-MM-DD
例：2017-09-01",
"type": "string",
"minLength": 10,
"maxLength": 10
},
"download_date": {
"description": "通知文書の取得完了日時
・半角
・YYYY-MM-DD HH:MM:SS
例：2017-09-01 09:30:00",
"type": "string",
"minLength": 19,
"maxLength": 19
},
"sign": {
"description": "通知文書の署名有無
・全角
あり／なし",
"type": "string",
"minLength": 2,
"maxLength": 2
}
}
}
},
"results_share_setting_lists": {
"type": "object",
"required": [
"share_setting_list"
],
"properties": {
"share_setting_list": {
"allOf": [
{
"$ref": "#/components/schemas/share_setting_lists"
}
]
}
}
},
"share_setting_lists": {
"type": "object",
"required": [
"gbiz_id",
"official_doc_permission",
"post_doc_permission"
],
"properties": {
"gbiz_id": {
"description": "共有中のgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"official_doc_permission": {
"description": "公文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
},
"post_doc_permission": {
"description": "電子送達の通知文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
}
}
},
"results_share-setting-post": {
"type": "object",
"required": [
"gbiz_id",
"official_doc_permission",
"post_doc_permission"
],
"properties": {
"gbiz_id": {
"description": "共有対象のgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"official_doc_permission": {
"description": "公文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
},
"post_doc_permission": {
"description": "電子送達の通知文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
}
}
},
"results_share-setting-put": {
"type": "object",
"required": [
"gbiz_id",
"official_doc_permission",
"post_doc_permission"
],
"properties": {
"gbiz_id": {
"description": "共有中のgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"official_doc_permission": {
"description": "公文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
},
"post_doc_permission": {
"description": "電子送達の通知文書に関する権限情報
・半角
READ:参照権限
DOWNLOAD:ダウンロード権限",
"type": "string",
"minLength": 4,
"maxLength": 8
}
}
},
"results_share-setting-delete": {
"type": "object",
"required": [
"gbiz_id"
],
"properties": {
"gbiz_id": {
"description": "解除したgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
}
}
},
"results_share-confirmation": {
"type": "object",
"required": [
"gbiz_id",
"share_acceptance"
],
"properties": {
"gbiz_id": {
"description": "共有依頼元のgBizIDのアカウントID(メールアドレス)
・半角",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"share_acceptance": {
"description": "共有設定の許可/不許可
・半角
ACCEPT：許可する
DENY：許可しない",
"type": "string",
"minLength": 4,
"maxLength": 6
}
}
}
}
}
}