本文へ移動
Bounty Developer

GET/api/events/{slug}/manage/tickets

「イベント」の分類の、情報を読み出す API。ログインした本人として呼ぶ。

要約

チケットの系統と段の一覧（4S との結びつき・同期の状態つき）

呼び方と印

ログイン

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

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

  • slugpath必須string

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

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

  • familiesarray<object>
    • idstring(uuid)
    • eventIdstring(uuid)
    • namestring長さ 1–100
    • descriptionstring | null長さ ≤1000
    • questionnaireIdstring(uuid) | null
    • paymentType"FREE" | "ONSITE_PAYMENT" | "PREPAID_STRIPE"
    • positioninteger≥0
    • archivedboolean
    • tiersarray<object | object>
      • |1object
        • origin"created" | "adopted"
        • foursTicketIdstring | null
        • foursUniqueIdstring | null
        • syncStateenum(6)"unlinked" "pending" "synced" "uncertain" "drift" "failed"
        • observedobject | null
          • status"DRAFT" | "PUBLISHED" | "PRIVATE"
          • pricenumber
          • salesLimitnumber | null
          • namestring
          • displayOrdernumber | null
          • soldCount任意number | null
          • requiresApproval任意boolean | null
          • invitationEnabled任意boolean | null
        • observedAtstring | null
        • idstring(uuid)
        • familyIdstring(uuid)
        • namestring長さ 1–100
        • priceinteger≥0
        • quantityinteger | null≥1
        • salesStartsAtstring(date-time) | null
        • salesEndsAtstring(date-time) | null
        • statusMode"auto" | "DRAFT" | "PUBLISHED" | "PRIVATE"
        • positioninteger≥0
        • baseTierId任意string(uuid) | null
        • descriptionPrefix任意string | null長さ ≤200
        • paymentType任意"FREE" | "ONSITE_PAYMENT" | "PREPAID_STRIPE" | null
        • requiresApproval任意boolean | null
        • distributor任意object | null
          • kind"guild" | "venture" | "user"
          • idstring(uuid)
        • kind"price"
        • visibility"public" | "link"
        • labelstring | null長さ 1–24
      • |2object
        • origin"created" | "adopted"
        • foursTicketIdstring | null
        • foursUniqueIdstring | null
        • syncStateenum(6)"unlinked" "pending" "synced" "uncertain" "drift" "failed"
        • observedobject | null
          • status"DRAFT" | "PUBLISHED" | "PRIVATE"
          • pricenumber
          • salesLimitnumber | null
          • namestring
          • displayOrdernumber | null
          • soldCount任意number | null
          • requiresApproval任意boolean | null
          • invitationEnabled任意boolean | null
        • observedAtstring | null
        • idstring(uuid)
        • familyIdstring(uuid)
        • namestring長さ 1–100
        • priceinteger≥0
        • quantityinteger≥1
        • salesStartsAtstring(date-time) | null
        • salesEndsAtstring(date-time) | null
        • statusMode"auto" | "DRAFT" | "PUBLISHED" | "PRIVATE"
        • positioninteger≥0
        • baseTierId任意string(uuid) | null
        • descriptionPrefix任意string | null長さ ≤200
        • paymentType任意"FREE" | "ONSITE_PAYMENT" | "PREPAID_STRIPE" | null
        • requiresApproval任意boolean | null
        • distributor任意object | null
          • kind"guild" | "venture" | "user"
          • idstring(uuid)
        • kind"limited"
        • visibility"link"
        • labelstring長さ 1–24
  • distributorsrecord<string>
  • shareobject
    • slugstring
    • primaryboolean
  • eligibility任意record<"link" | "org_members">

失敗したとき（エラー）

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

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

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/events/{slug}/manage/tickets" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/events/{slug}/manage/tickets | Bounty Developer