本文へ移動
Bounty Developer

PUT/api/events/{slug}/manage/tickets/{familyId}

「イベント」の分類の、送った内容で対象を保存する(更新する)API。ログインした本人として呼ぶ。

要約

チケットの系統を直す(4S に作った段がある系統は支払いの種類を変えられない)

呼び方と印

ログイン

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

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

  • slugpath必須string
  • familyIdpath必須string(uuid)

送るもの(本文)application/json

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

  • name必須string
    長さ 1–100
  • description必須string | null
    長さ ≤1000
  • questionnaireId必須string(uuid) | null
  • paymentType必須"FREE" | "ONSITE_PAYMENT" | "PREPAID_STRIPE"
  • position任意integer
    ≥0

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

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

  • familyobject
    • idstring(uuid)
    • eventIdstring(uuid)
    • namestring長さ 1–100
    • descriptionstring | null長さ ≤1000
    • questionnaireIdstring(uuid) | null
    • paymentType"FREE" | "ONSITE_PAYMENT" | "PREPAID_STRIPE"
    • positioninteger≥0
    • archivedboolean

失敗したとき(エラー)

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

  • 400入力の誤り(error = invalid_input など)
  • 401未ログイン(unauthorized)/ Bearer が無効(invalid_token。WWW-Authenticate 付き)
  • 403権限が無い
  • 409HTTP 409(x-bounty-error-codes を参照)
  • 422HTTP 422(x-bounty-error-codes を参照)
  • event_not_found
  • feature_disabled
  • forbidden
  • manager_reverify_required
  • human_action_required
  • invalid_input
  • family_not_found
  • family_archived
  • family_payment_locked
  • ticket_rules_violation
  • questionnaire_not_found

呼び出しの見本

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

curl -X PUT "https://bounty.spikes.4s.link/api/events/{slug}/manage/tickets/{familyId}" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "questionnaireId": "00000000-0000-4000-8000-000000000000",
    "paymentType": "FREE"
  }'
PUT /api/events/{slug}/manage/tickets/{familyId} | Bounty Developer