お知らせ一覧取得＿API

概要

{success} KIZUNA に表示するお知らせを一覧で取得する API です。

エンドポイント

メソッド URI Headers
GET /api/notification/list/{page}/{per_page}?search=〇〇 Default

リクエストパラメーター

/api/member/list/0/50?search=〇〇

ROUTE パラメータ

パラメーター名 型 内容 特記
page int 現在のページ（何回実行したか何 P 目かを表す） 以降加算されていく
per_page int リクエスト件数（50 なら 50 件返却）

{primary} pageが 0 の時は＝ 1 ページ目　/　 1 の時は 2 ページ目と同義となります。

GET パラメータ

パラメーター名 型 内容 特記
search string タイトル 　空白区切り　で LIKE 検索 絞り込み検索時のみ付加されます。

{primary} ?search=は絞り込み検索時のみ付加されます。

レスポンス

成功時
パラメーター名 型 内容 特記
id int お知らせの ID
release_date string お知らせ公開日(/区切り)
type int お知らせの種類 1：システムからのお知らせ　 5：緊急
name string お知らせのタイトル
status int お知らせ状態 1：予約中　 5：公開中　 10：未公開 
{
  "result"   : true,
  "errors"   : "",
  "data"     : [
    {
      'id'                : 1,
      'release_date'      : '2021/01/01',
      'type'              : 1,
      'name'              : 'KIZUNAアップデート(ver2.0)のお知らせ',
      'status'            : 10,
    },
    {
      'id'                : 2,
      'release_date'      : '2021/12/25',
      'type'              : 5,
      'name'              : 'メンテナンスのお知らせ',
      'status'            : 1,
    },
  ],
}

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

失敗時

ステータスコード：200

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

{primary} 失敗は基本的に想定していません。

データ取得

データ取得 SQL

RUN