本文へ移動
Bounty Developer

GET/api/orgs/enrichment/{id}

「学生団体・ベンチャー」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

団体紹介の提案と根拠を読む（運営 moderator のみ）

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

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

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

  • idpath必須string(uuid)

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

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

  • revisionIdstring(uuid)
  • kind"guild" | "venture"
  • idstring(uuid)
  • descriptionstring
  • sourceUrlstring
  • observedAtstring
  • sourceHashstring/^[0-9a-f]{64}$/
  • hashstring/^[0-9a-f]{64}$/
  • status"pending" | "approved" | "rejected" | "superseded"
  • currentRevisionstring/^[0-9a-f]{64}$/

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401HTTP 401（x-bounty-error-codes を参照）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429HTTP 429（x-bounty-error-codes を参照）

呼び出しの見本

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

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