計画認定プロジェクト - 一覧 API

概要

{primary} 検索条件にて絞り込んだ計画認定プロジェクトのレコードのリストを返却します。

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

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

実習実施先アカウントは計画認定プロジェクトのデータ参照は出来ません。

エンドポイント

メソッド URI Headers
GET /api/application/list Default

リクエストパラメータ

パラメーター名 型 内容 特記
page int ページ番号 何ページ目をリクエストするか
entry_expected_ym string 年月 NULLの場合全て
project_status int 実習実施先名絞り込み enum : ProjectStatus 2:作成中 or 3:完了
keyword string 実習実施先名のキーワード検索 実習実施先名の部分一致検索

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
data[][id] int 計画認定プロジェクトID
data[][company_id] int 実習実施先ID
data[][target_trainee_class] int 新規作成時に選択した技能実習区分の種別
data[][progress] int 進捗状況 @todo STEP画面実装していないので、固定で１を返すようにしています。
data[][numof_trainees] int 技能実習生人数
data[][created_at] date 開始日
data[][entry_expected_date] date 入国予定日 最も近い入国予定日
data[][trainees][][id] int 技能実習生ID
data[][trainees][][romaji] string 技能実習生氏名 ローマ字
data[][trainees][][kana] string 技能実習生氏名 カナ
data[][trainees][][sex] int 性別
data[][trainees][][nationality] int 国籍
data[][trainees][][company_office_id] int 実習実施先 事業所ID 
{
    "result"   : true,
    "errors"   : "",
    "data"     : [
        {
            "id"                   : 1,
            "company_id"           : 1,
            "subject"              : "管理費",
            "total_amount"         : "100000",
            "email"                : "test1@example.com",
            "publishing_date"      : "2023/02/01",
            "email_sent_at"        : "2023/02/05 12:00",
            "trainees": [
                {
                    "id": 3827,
                    "romaji": "中津川 知実",
                    "kana": "自動生成氏名カナ",
                    "sex": 1,
                    "nationality": 1,
                    "company_office_id": 375
                }
            ]
        },
        {
            "id"                   : 2,
            "company_id"           : 1,
            "subject"              : "管理費",
            "total_amount"         : "100000",
            "email"                : "test2@example.com",
            "publishing_date"      : "2023/02/01",
            "email_sent_at"        : "2023/02/05 12:00",
            "trainees": [
                {
                    "id": 3883,
                    "romaji": "浜田 和也",
                    "kana": "自動生成氏名カナ",
                    "sex": 1,
                    "nationality": 5,
                    "company_office_id": 912
                }
            ]
        },
        {
            "id"                   : 3,
            "company_id"           : 1,
            "subject"              : "管理費",
            "total_amount"         : "100000",
            "email"                : "test3@example.com",
            "publishing_date"      : "2023/02/01",
            "email_sent_at"        : "2023/02/05 12:00",
            "trainees"             : [
                {
                    "id": 3824,
                    "romaji": "伊藤 舞",
                    "kana": "自動生成氏名カナ",
                    "sex": 1,
                    "nationality": 15,
                    "company_office_id": 11
                },
                {
                    "id": 3825,
                    "romaji": "大垣 康弘",
                    "kana": "自動生成氏名カナ",
                    "sex": 2,
                    "nationality": 3,
                    "company_office_id": 12
                },
                {
                    "id": 3837,
                    "romaji": "斉藤 翼",
                    "kana": "自動生成氏名カナ",
                    "sex": 1,
                    "nationality": 10,
                    "company_office_id": 443
                }
            ]
        }
    ],
}

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

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

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

{danger} 失敗時は200以外のエラーコードが返却されます。共通ルールのレスポンスをチェック。