技能実習生管理 - 計画認定内実習生一覧取得 API
- [技能実習生管理 - 計画認定内実習生一覧取得 API](#技能実習生管理 - 計画認定内実習生一覧取得-api)
概要
{primary} 計画認定プロジェト内にいる技能実習生の一覧を返却します。
エンドポイント
| メソッド |
URI |
Headers |
| GET |
/api/application/trainee/list/{id} |
Default |
ROUTEパラメータ
| パラメーター名 |
必須 |
型 |
内容 |
特記 |
| id |
〇 |
int |
計画認定プロジェクトID |
|
レスポンス
成功時
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
true |
| errors |
array |
成功のためエラーがないので空配列が返ってきます |
|
| romaji |
string |
氏名 |
|
| nationality |
tinyInt |
国籍 |
|
| sex |
int |
性別 |
|
| birthday |
date |
生年月日 |
|
| entry_expected_date |
date |
入国予定日 |
|
| company_office_name |
string |
所属先事業所 |
@todo UI/UX次第ではIDに変更する可能性もあり |
{
"result" : true,
"errors" : "",
"data" : [],
}
失敗時
ステータスコード:200
| パラメーター名 |
型 |
内容 |
特記 |
| result |
boolean |
リクエスト結果 |
|
| error |
List |
失敗した理由を配列 |
|
{
"result" : false,
"errors" : {
'error' : ['失敗しました'],
},
"data" : "",
}
{danger} 失敗時は200以外のエラーコードが返却されます。共通ルールのレスポンスをチェック。