通知
アプリの中の通知の API。通知の一覧を読み、既読にする・消す。
この分類のあらまし
- 誰が呼べるか
ログインした本人。
ログイン 5 件
- 件数と印
この分類の API は 5 件・ポーリング 1 件
画面が一定の間隔で呼び直す前提の API(ポーリング)。
- 契約での分類の説明
通知
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API5 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- 通知の一覧(?filter=unread・?before=<nextBefore>・?limit=。各項目に東京時間の日付の区切り group)GET取得
/api/notificationsログイン・ポーリング - 通知を既読にする(all か ids)POST作成・操作
/api/notifications/readログイン - 通知を 1 件既読にするPOST作成・操作
/api/notifications/{id}/readログイン - 通知を 1 件消すDELETE削除
/api/notifications/{id}ログイン - 既読の通知をまとめて消すPOST作成・操作
/api/notifications/clearログイン