本文へ移動
Bounty Developer

GET/api/contents/{id}/survey

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

要約

参加したコンテンツの星評価と本人の共有設定

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

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

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

  • titlestring
  • checkedInboolean
  • responseobject | null
    • speakerRatingsrecord<string>
    • starsinteger | null1–5
    • commentstring | null
    • followUpstring | null
    • updatedAtstring
  • sharingobject
    • shareCheckinboolean
    • shareSurveyboolean
  • recipientsarray<object>
    • namestring
    • shareCheckinsboolean
    • shareSurveysboolean
  • recipientVersionstring/^[0-9a-f]{64}$/

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • content_not_found
  • content_feature_disabled

呼び出しの見本

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

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