スケジュール - 新規登録・編集 API

概要

{primary} 計画認定作成にあたってのスケジュール管理を行う機能です。

スケジュールの登録、編集を行います。

監理団体アカウントのみ利用できます。

エンドポイント

メソッド URI Headers
POST /api/application/doc_schedules Default

ROUTEパラメータ

パラメーター名 型 内容 特記

リクエストパラメータ

パラメーター名 必須 型 内容 特記
id int id 新規作成時NULL / 編集時のみ必須
appdoc_project_id 〇 int 計画認定プロジェクトID
user_id 〇 int ユーザーID
task_name 〇 string 課題名
task_progress 〇 int 状態 1:未着手, 5:着手中, 10:完了
task_from 〇 date 開始日
task_until 〇 date 終了日
remarks text 備考

レスポンス

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

ステータスコード：200

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

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

バリデーション

画面項目名 フィールド名 チェック内容 備考
課題名 task_name required
担当者 user_id required
状態 task_progress required
1, 5, 10の数値かどうか
開始日 task_start_date required
日付型チェック
終了日よりも前かどうか
終了日 task_end_date required
日付型チェック
開始日よりも後かどうか