本文へ移動
Bounty Developer

POST/api/contents/{id}/survey

「セッション」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約

星とひとことを保存（チェックイン必須・初回だけ得点）

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • stars必須integer
    1–5
  • comment任意string
    長さ ≤280 · 既定 ""
  • shareCheckin任意boolean
    既定 false
  • shareSurvey任意boolean
    既定 false
  • recipientVersion任意string
    /^[0-9a-f]{64}$/

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

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

  • oktrue
  • awardedboolean
  • pointsnumber

失敗したとき（エラー）

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

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

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/contents/{id}/survey" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "stars": 1
  }'
POST /api/contents/{id}/survey | Bounty Developer