計画認定プロジェクト用技能実習生一覧 API


概要

{primary} 計画認定プロジェクト新規登録画面にて、プロジェクトに追加する技能実習生のリストを取得します。

監理団体アカウントで、ステータスが 5:利用中 のユーザのみ利用できます。

監理団体アカウントはマスター、管理者、一般に制限なく使用可能です。

実習実施先アカウントは計画認定プロジェクトの新規登録にアクセスできないのでこちらのデータ参照も出来ません。


エンドポイント

メソッド URI Headers
GET /api/application/trainees/{target_trainee_class} Default

リクエストパラメータ

パラメーター名 内容 特記
target_trainee_class int 技能実習生区分 1:1号, 2:2号, 3:3号
  • target_trainee_classは現在の技能実習区分ではなく、次になる技能実習区分を設定してください。

レスポンス

成功時
パラメーター名 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
data[trainees][][id] int 技能実習生ID
data[trainees][][name] string 技能実習生の国籍 + 技能実習生の氏名(ローマ字)
data[trainees][][company_id] int 実習実施先ID
data[trainees][][company_office_id] int 実習実施先 事業所ID
data[trainees][][is_available] boolean 計画認定プロジェクトに追加可能か? 計画認定プロジェクトに追加可能であればtrue, 不可であればfalse
data[has_available] boolean 計画認定プロジェクトに追加可能な技能実習生が含まれるか? 計画認定プロジェクトに追加可能な実習生が含まれる場合はtrue, 含まれない場合はfalse
alert array 成功のためエラーがないので空配列が返ってきます

{
    "data": {
        "trainees": [
            {
                "id": 19,
                "company_id": 8,
                "company_office_id": 12,
                "name": "モンゴル | test saburo",
                "is_available": false
            },
            {
                "id": 640,
                "company_id": 8,
                "company_office_id": 12,
                "name": "モンゴル | ああああい",
                "is_available": false
            },
            {
                "id": 3868,
                "company_id": 8,
                "company_office_id": 443,
                "name": "ラオス | 廣川 英樹",
                "is_available": false
            }
        ],
        "has_available": false
    },
    "result": true,
    "errors": [],
    "alert": []
}```

> {primary} 何もなければ空配列で返却。検索条件で何も引っかからなかった場合を

> 想定しています。取得するデータが存在しないため

> 失敗ではなく、成功として返却します。

>{danger} 失敗時は200以外のエラーコードが返却されます。[共通ルールのレスポンス](/docs/1.2/system_api/overview)をチェック。

---