準備機関 - 新規登録・編集 API
概要
{primary} 検索条件にて絞り込んだ準備機関のレコードのリストを返却します。
監理団体アカウントのみ利用できます。
エンドポイント
| メソッド |
URI |
Headers |
| POST |
/api/application/preparation_agency |
Default |
ROUTEパラメータ
リクエストパラメータ
| パラメーター名 |
必須 |
型 |
内容 |
特記 |
| id |
|
int |
id |
新規作成時NULL / 編集時のみ必須 |
| country |
〇 |
int |
送出国 |
|
| preparation_agency_type |
〇 |
int |
種別 |
1:準備機関 5:公的機関 |
| name |
〇 |
string |
機関名称 |
|
| address |
|
string |
所在地 |
|
| representative_name |
|
string |
代表者氏名 |
|
| main_business |
|
string |
主要業務 |
|
| phone |
|
string |
電話番号 |
|
| email |
|
string |
メールアドレス |
|
| founding_date |
|
date |
設立年月日 |
リニューアル版では「年」「月」「日」の入力項目が1つになっています。 |
| numof_employee |
|
int |
常勤職員数 |
|
| capital_amount |
|
int |
資本金(金額) |
|
| capital_unit |
|
int |
資本金(単位) |
|
| capital_rate |
|
string |
資本金(レート) |
|
| capital_amount_yen |
|
int |
資本金(日本円) |
|
| supervisor_rank |
|
string |
責任者役職 |
|
| supervisor_name |
|
string |
責任者氏名 |
|
レスポンス
成功時
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
true |
| errors |
array |
成功のためエラーがないので空配列が返ってきます |
|
{
"result" : true,
"errors" : "",
"data" : [],
}
失敗時
ステータスコード:200
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
|
| error |
List |
失敗した理由を配列 |
|
{
"result" : false,
"errors" : {
'error' : ['失敗しました'],
},
"data" : "",
}
{danger} 失敗時は200以外のエラーコードが返却されます。共通ルールのレスポンスをチェック。
バリデーション
| 画面項目名 |
フィールド名 |
チェック内容 |
備考 |
| id |
id |
required |
|
| 送出国 |
country |
required |
|
| 種別 |
preparation_agency_type |
required |
|
| 機関名称 |
name |
required |
|
|
|
max:255 |
|
| 所在地 |
address |
nullable |
|
|
|
max:255 |
|
| 代表者氏名 |
representative_name |
nullable |
|
|
|
max:255 |
|
| 主要業務 |
main_business |
nullable |
|
|
|
max:255 |
|
| 電話番号 |
phone |
nullable |
|
|
|
max:20 |
|
| メールアドレス |
email |
nullable |
|
|
|
max:255 |
|
|
|
型チェック |
|
| 設立年月日 |
founding_date |
nullable |
|
|
|
日付チェック |
|
| 常勤職員数 |
numof_employee |
nullable |
|
|
|
max:10 |
|
| 資本金(金額) |
capital_amount |
nullable |
|
|
|
max:10 |
|
| 資本金(単位) |
capital_unit |
nullable |
|
| 資本金(レート) |
capital_rate |
nullable |
|
|
|
max:10 |
|
| 資本金(日本円) |
capital_amount_yen |
nullable |
|
|
|
max:10 |
|
| 責任者役職 |
supervisor_rank |
nullable |
|
|
|
max:255 |
|
| 責任者氏名 |
supervisor_name |
nullable |
|
|
|
max:255 |
|