備考 - 一覧 API

概要

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

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

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

エンドポイント

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

リクエストパラメータ

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

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 true
errors array 成功のためエラーがないので空配列が返ってきます
id int 備考ID
appdoc_project_id int 計画認定プロジェクトID
created_at datetime 登録日時
user_name string アカウント名
content string 内容 
{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        0 : {
            "id"                : 1,
            "appdoc_project_id" : 1,
            "created_at"        : "2023/02/01",
            "account_name"      : "田中太郎",
            "content"           : "テスト内容"
        }
    },
}
失敗時

ステータスコード：200

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

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

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

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

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