計画認定TOP - 期限が過ぎているスケジュール一覧 API

概要

{primary} 計画認定TOPで、開始日が来ているのに未着手または終了日が来ているのに未完了の

タスクの一覧を返却するAPIです。

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

エンドポイント

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

リクエストパラメータ

パラメーター名 型 内容 特記
per_page int 件数 default:50
pages int ページ数 何 P 目をリクエストするか

レスポンス

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

ステータスコード：200

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

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

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

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

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