ステップ制御 - ステップ完了 API

概要

{primary} 計画認定プロジェトの進捗状況を管理します。

STEP1～STEP7までの各STEPのステータス(未完了⇒完了)を変更します。

１度完了したSTEPを未完了に戻すことは出来ません。

エンドポイント

メソッド URI Headers
GET /api/application/step/{step_number}/get_progress Default

ROUTEパラメータ

パラメーター名 必須 型 内容 特記
step_number 〇 int 1~3

レスポンス

成功時
ステップ パラメーター名 型 内容 特記
共通 result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
Step1 progress[organization_basic_info] int 監理団体の基本情報の進捗率
progress[organization_offices] int 監理団体の担当事業所の進捗率
progress[organization_staffs] int 監理団体の理事・職員の進捗率
Step2 progress[company_basic_info] int 実習実施先の基本情報の進捗率
progress[company_records] int 実習実施先の実績の進捗率
progress[company_executives] int 実習実施先の役員の進捗率
Step3 progress[trainee_basic_info] int 技能実習生の基本情報の進捗率
progress[trainee_employments] int 技能実習生の雇用労働の進捗率
progress[trainee_treatments] int 技能実習生の待遇の進捗率
progress[trainee_certificates] int 技能実習生の所属機関の進捗率
progress[sending_agencies] int 送出国の進捗率 
{
    "result"   : true,
    "errors"   : "",
    "data"     : [],
}
失敗時

ステータスコード：200

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

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