お知らせ詳細取得＿API

概要

{success} KIZUNAに表示するお知らせの詳細取得 API です。

エンドポイント

メソッド URI Headers
GET /api/notification/{id} Default

リクエストパラメーター

パラメーター名 型 内容 特記
id int お知らせ ID 
/api/notification/1

レスポンス

成功時
パラメーター名 型 内容 特記
id int id
status int 状態 1：予約中　 5：公開中　 10：未公開
type int 種類 1：システムからのお知らせ　 5：緊急
name string お知らせタイトル
release_date string 公開日 /区切り
limit_date string 期限日 /区切り
contents string 内容 
{
  "result"   : true,
  "errors"   : "",
  "data"     : {
    'id'                            : 1,
    'status'                        : 1,
    'type'                          : 1,
    'name'                          : 'KIZUNAアップデートのお知らせ',
    'release_date'                  : '2021/01/01',
    'limit_date'                    : '2021/02/01',
    'contents'                      : 'TESTTESTTESTTESTTESTTESTTESTTESTTESTTESTTESTTEST',
  },
}

{primary} 何もなければ空配列で返却します。

失敗時

ステータスコード：200

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

データ取得

RUN