お知らせ更新・新規登録＿API

概要

KIZUNAに表示するお知らせの更新・新規作成 API です。

ID がセットされているかどうかで更新か新規作成か、判別します。

エンドポイント

メソッド URI Headers
POST /api/notification Default

リクエストパラメーター

パラメーター名 型 内容 特記
id int id 存在すれば更新 nullであれば新規作成
type int 種類 1：システムからのお知らせ　 5：緊急
title string お知らせタイトル
release_date string 公開日 Y/m/d H:i
limit_date string 期限日 Y/m/d H:i nullable
contents string 内容 
{
    'id'                            : 1,
    'type'                          : 1,
    'title'                         : 'KIZUNAアップデートのお知らせ',
    'release_date'                  : '2021/01/01 11:11',
    'limit_date'                    : '2021/02/01 01:11' ,
    'contents'                      : 'TESTTESTTESTTESTTESTTESTTESTTESTTESTTESTTESTTEST',
}

{primary} 新規作成の場合は ID を NULL にしてリクエスト

レスポンス

成功時
パラメーター名 型 内容 特記
id int id 
{
  "result"   : true,
  "errors"   : "",
  "data"     : {
    'id': 1,
  },
}
失敗時

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
error List
id int id int
type int 種類 int 必須
title string お知らせタイトル 80 文字まで　必須
release_date string 公開日 Y/m/d H:i　必須
limit_date string 期限日 Y/m/d H:i release_date<
contents string 内容 10000 文字まで 
{
  "result"   : false,
  "errors"                      : {
    'id'                            : $err,
    'type'                          : $err,
    'title'                         : $err,
    'release_date'                  : $err,
    'limit_date'                    : $err,
    'contents'                      : $err,
  },
  "data"     : "",
}

RUN