ステップ制御 - 全ステップのステータス取得 API

概要

{primary} 計画認定プロジェトの全ステップの進捗状況を取得します。

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

エンドポイント

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

ROUTEパラメータ

パラメーター名 必須 型 内容 特記
id 〇 int 計画認定プロジェクトID

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
step1_status int STEP_1ステータス 1：未完了、2：完了
step2_status int STEP_2ステータス 1：未完了、2：完了
step3_status int STEP_3ステータス 1：未完了、2：完了
step4_status int STEP_4ステータス 1：未完了、2：完了
step5_status int STEP_5ステータス 1：未完了、2：完了
step6_status int STEP_6ステータス 1：未完了、2：完了
step7_status int STEP_7ステータス 1：未完了、2：STEP1、3：STEP2、4：STEP3、5：完了 
{
    "result"   : true,
    "errors"   : "",
    "data"     : [],
}
失敗時

ステータスコード：200

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

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