本文へ移動
Bounty Developer

PATCH/api/boshu/calls/{id}/owner

「BOSHU の管理」の分類の、対象のうち、送った項目だけを直す API。ログインした本人として呼ぶ。

要約

現在と移動先両主体の管理権限を確認して引き継ぐ。応募/回答を保持し共同管理者は解除

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)

送るもの（本文）application/json

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

  • kind必須enum(5)
    • "platform"
    • "event"
    • "guild"
    • "venture"
    • "person"
  • id必須string(uuid) | null

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

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

  • callIdstring
  • managementHrefstring
  • ownerobject
    • kindenum(5)"platform" "event" "guild" "venture" "person"
    • idstring | null
    • namestring
    • logoUrlstring | null
  • canManageMembersboolean
  • canTransferboolean
  • managersarray<object>
    • userIdstring
    • displayNamestring
    • avatarUrlstring | null
    • activeboolean
  • eventOperatorsobject | null
    • eventTitlestring
    • countinteger≥0
    • peoplearray<object>
      • userIdstring
      • displayNamestring
  • allowedOwnersarray<object>
    • kindenum(5)"platform" "event" "guild" "venture" "person"
    • idstring | null
    • namestring
    • logoUrlstring | null

失敗したとき（エラー）

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

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）

呼び出しの見本

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

curl -X PATCH "https://bounty.spikes.4s.link/api/boshu/calls/{id}/owner" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "platform",
    "id": "00000000-0000-4000-8000-000000000000"
  }'
PATCH /api/boshu/calls/{id}/owner | Bounty Developer