監理費請求 - 実習実施先配属数取得 API

概要

{primary} 実習実施先のセレクトボックスを選択した際に、その実習実施先の現在の配属者数を取得するAPIです。

エンドポイント

メソッド URI Headers
GET /api/bill/numof_assignments/{company_id} Default

ROUTEパラメータ

パラメーター名 型 内容 特記
company_id int 実習実施先ID

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
trainee_class_1_count int 実習実施先に所属している技能実習生1号の人数
trainee_class_2_count int 実習実施先に所属している技能実習生2号の人数
trainee_class_3_count int 実習実施先に所属している技能実習生3号の人数 
{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        "trainee_class_1_count" : 10,
        "trainee_class_2_count" : 4,
        "trainee_class_3_count" : 6
    },
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
error List 失敗した理由を配列 
{
  "result"   : false,
  "errors"   : {
    'error'       : ['失敗しました'],
  },
  "data"     : "",
}

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

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

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

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

データ取得

  • 技能実習生１号の人数取得
SELECT
    *
FROM
    `trainees`
WHERE
        `company_id` = $request->getInput('company_id')
    AND `status` = TraineeStatus::APPRENTICESHIP()
    AND `trainee_class` = 1
    AND `organization_bills`.`deleted_at` IS NULL
  • 技能実習生２号の人数取得
SELECT
    *
FROM
    `trainees`
WHERE
        `company_id` = $request->getInput('company_id')
    AND `status` = TraineeStatus::APPRENTICESHIP()
    AND `trainee_class` = 2
    AND `organization_bills`.`deleted_at` IS NULL
  • 技能実習生３号の人数取得
SELECT
    *
FROM
    `trainees`
WHERE
        `company_id` = $request->getInput('company_id')
    AND `status` = TraineeStatus::APPRENTICESHIP()
    AND `trainee_class` = 3
    AND `organization_bills`.`deleted_at` IS NULL