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


概要

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

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

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


エンドポイント

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

ROUTEパラメータ

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

レスポンス

成功時
パラメーター名 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
{
    "result"   : true,
    "errors"   : "",
    "data"     : [],
}
失敗時

ステータスコード:200

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

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


データストア / 計画認定プロジェクト

  • appdoc_projectsテーブル
論理名 物理名 バリデーション 備考
STEP_1ステータス step1_status 必須 ※1回のAPIで登録されるのはSTEP1~7のうちの一つだけ
STEP_2ステータス step2_status 必須 ※1回のAPIで登録されるのはSTEP1~7のうちの一つだけ
STEP_3ステータス step3_status 必須 ※1回のAPIで登録されるのはSTEP1~7のうちの一つだけ
STEP_4ステータス step4_status 必須 ※1回のAPIで登録されるのはSTEP1~7のうちの一つだけ
STEP_5ステータス step5_status 必須 ※1回のAPIで登録されるのはSTEP1~7のうちの一つだけ
STEP_6ステータス step6_status 必須 ※1回のAPIで登録されるのはSTEP1~7のうちの一つだけ
STEP_7ステータス step7_status 必須 ※1回のAPIで登録されるのはSTEP1~7のうちの一つだけ