本文へ移動
Bounty Developer

GET/api/event-content/{id}/records

「コンテンツ企画」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

共有を受けたチェックインの名簿とアンケートの回答(見てよい分だけ)

呼び方と印

ログイン

URL に付ける値(パラメータ)

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

  • idpath必須string(uuid)

返るもの(応答)200 · application/json

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

  • contactsarray<object>
    • idstring
    • displayNamestring
    • avatarUrlstring | null
    • titlestring | null
    • orgNamestring | null
    • representativeIdstring | null
    • atstring
  • responsesarray<object>
    • userIdstring
    • starsinteger | null
    • commentstring | null
  • canSeeRosterboolean
  • canSeeSurveysboolean

失敗したとき(エラー)

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

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

呼び出しの見本

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

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