セッション
会場のセッションの API。参加者はアンケートと星の評価、Q&A の投稿とリアクション、ライブの投票をする。主催は参加者に出す画面を切り替え、投票を始める・終える、Q&A を整理する、アンケートを集計する。
この分類のあらまし
- 誰が呼べるか
ログインした参加者。要約に「主催」とある入口は、そのセッションの主催が呼ぶ。
ログイン 16 件
- 件数と印
この分類の API は 16 件・ポーリング 4 件・レート制限 2 件
画面が一定の間隔で呼び直す前提の API(ポーリング)。
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
- 契約での分類の説明
セッション(会場)
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API16 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- 参加したコンテンツの星評価と本人の共有設定GET取得
/api/contents/{id}/surveyログイン - 星とひとことを保存(チェックイン必須・初回だけ得点)POST作成・操作
/api/contents/{id}/surveyログイン - 自分のアンケート回答GET取得
/api/sessions/{id}/surveyログイン - アンケート回答の保存(初回だけ得点)POST作成・操作
/api/sessions/{id}/surveyログイン - Q&A の一覧GET取得
/api/sessions/{id}/qaログイン・ポーリング - 質問・コメントの投稿POST作成・操作
/api/sessions/{id}/qaログイン・レート制限 - Q&A へのリアクション(トグル)POST作成・操作
/api/sessions/{id}/qa/reactログイン・レート制限 - 今の投票とライブ集計GET取得
/api/sessions/{id}/liveログイン・ポーリング - 投票(1 人 1 票)POST作成・操作
/api/sessions/{id}/live/respondログイン - 主催が参加者に出している画面(アンケート / Q&A。ETag が同じなら 304)GET取得
/api/sessions/{id}/engageログイン・ポーリング - 参加者全員に出す画面を切り替える(主催)POST作成・操作
/api/sessions/{id}/host/viewログイン - 投票を始める・終える(主催)POST作成・操作
/api/sessions/{id}/live/host-promptログイン - 主催として Q&A に投稿するPOST作成・操作
/api/sessions/{id}/qa/hostログイン - Q&A の非表示・承認・ピン留め・回答済み・事前承認(主催)POST作成・操作
/api/sessions/{id}/qa/moderateログイン - 自分を視聴中に記録し、今見ている人数を返すGET取得
/api/sessions/{id}/qa/presenceログイン・ポーリング - アンケートの集計(登壇者ごとの評価・コメント・登壇者へのメッセージ。主催)GET取得
/api/sessions/{id}/survey/aggregateログイン