スケジュール - 一覧 API

概要

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

ガントチャート機能です。

監理団体のユーザのみ利用できます。

エンドポイント

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

リクエストパラメータ

パラメーター名 型 内容 特記
appdoc_project_id int 計画認定プロジェクトID
per_page int 件数 default:50
pages int ページ数 何 P 目をリクエストするか

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
id int スケジュールID
task_name string 課題名
user_name string 担当者
task_progress int 状態 1:未着手, 5:着手中, 10:完了
task_from date 開始日
task_until date 終了日
remarks text 備考
is_task_overdue boolean タスクの期限が過ぎているかどうかのフラグ 0:過ぎていない, 1:開始日が過ぎているのに未着手, 2:終了日が過ぎているのに未完了 
{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        0 : {
            "id"              : 1,
            "task_name"       : "タスク名",
            "user_name"       : "担当者名",
            "task_progress"   : 1,
            "task_from"       : "2023/02/15",
            "task_until"      : "2023/02/01",
            "remarks"         : "備考"
        }
    },
}
失敗時

ステータスコード：200

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

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

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

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

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