本文へ移動
Bounty Developer

POST/api/events/{slug}/manage/partners/roster

「イベント」の分類の、新しく作る、または操作を実行するために内容を送る API。ブラウザでログインした本人(cookie)として呼ぶ。

要約

主以外のイベントのパートナー一覧へ追加・解除する(そのイベントの管理者だけ。本文に eventId は持たない。原票・申請・団体・出展は保持)

呼び方と印

ログイン(cookie)・レート制限

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

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

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

  • slugpath必須string

送るもの(本文)application/json

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

  • target必須object
  • kind必須enum(5)
    • "guild"
    • "venture"
    • "company"
    • "intake"
    • "platform-intake"
  • id必須string(uuid)
  • included必須boolean
  • expectedRevision必須integer
    ≥0
  • confirmed必須true

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

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

  • oktrue
  • revisioninteger≥0
  • includedboolean

失敗したとき(エラー)

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

  • 400HTTP 400(x-bounty-error-codes を参照)
  • 401HTTP 401(x-bounty-error-codes を参照)
  • 403HTTP 403(x-bounty-error-codes を参照)
  • 404HTTP 404(x-bounty-error-codes を参照)
  • 409HTTP 409(x-bounty-error-codes を参照)
  • 413HTTP 413(x-bounty-error-codes を参照)
  • 415HTTP 415(x-bounty-error-codes を参照)
  • 428HTTP 428(x-bounty-error-codes を参照)
  • 429HTTP 429(x-bounty-error-codes を参照)
  • 500HTTP 500(x-bounty-error-codes を参照)
  • 503HTTP 503(x-bounty-error-codes を参照)
  • forbidden
  • not_found
  • event_not_found
  • manager_reverify_required
  • session_required
  • invalid_origin
  • unsupported_media_type
  • invalid_input
  • payload_too_large
  • subject_not_found
  • partner_not_found
  • revision_conflict
  • partner_roster_limit
  • partner_roster_invalid
  • consent_required
  • rate_limited
  • internal_error

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/events/{slug}/manage/partners/roster" \
  -b "bounty_session=$COOKIE_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "target": {
      "kind": "guild",
      "id": "00000000-0000-4000-8000-000000000000"
    },
    "included": false,
    "expectedRevision": 0,
    "confirmed": true
  }'
POST /api/events/{slug}/manage/partners/roster | Bounty Developer