本文へ移動
Bounty Developer

GET/api/sessions/{id}/engage

「セッション」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

主催が参加者に出している画面（アンケート / Q&A。ETag が同じなら 304）

呼び方と印

ログイン・ポーリング

画面が一定の間隔で呼び直す前提の API（ポーリング）。

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • idpath必須string(uuid)

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • revinteger
  • liveView"survey" | "qa"
  • liveViewRevinteger
  • surveyEnabledboolean
  • qaEnabledboolean

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • not_found

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl "https://bounty.spikes.4s.link/api/sessions/{id}/engage" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/sessions/{id}/engage | Bounty Developer