本文へ移動
Bounty Developer

GET/api/events/{slug}/ticketing

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

要約

選択イベントのチケットと本人の登録状態

呼び方と印

ログイン

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

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

  • slugpath必須string
  • expectedEventIdquery任意string(uuid)
  • expectedActorIdquery任意string(uuid)
  • codequery任意string
    /^[A-Z0-9]{8}$/
  • linkquery任意string
    /^[A-Za-z0-9_-]{1,100}$/

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

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

  • eventobject
    • idstring(uuid)
    • slugstring
    • foursEventIdstring
    • titlestring
    • webUrlstring(uri)
  • actorIdstring(uuid)
  • revisionstring/^[a-f0-9]{64}$/
  • mode"live" | "off"
  • offReason"disabled" | "not_linked" | null
  • ticketsarray<object>
    • uniqueId任意string(uuid)
    • idstring
    • namestring
    • descriptionstring | null
    • pricenumber
    • paymentType"FREE" | "ONSITE_PAYMENT" | "PREPAID_STRIPE"
    • requiresApprovalboolean
    • soldOutboolean
    • lowStockboolean
    • prepaidAvailableboolean | null
    • displayOrdernumber
    • invitedboolean
    • discountedPricenumber | null
    • discountPercentnumber | null
    • discountAmountnumber | null
    • tier任意object
      • tierIdstring(uuid)
      • familyIdstring(uuid)
      • kind"price" | "limited"
      • labelstring | null
      • salesStartsAtstring | null
      • salesEndsAtstring | null
  • ticketsAvailableboolean
  • invitationobject | object | null
    • |1object
      • validtrue
      • codestring
      • targetobject
        • idstring
        • namestring
        • descriptionstring | null
        • pricenumber
        • paymentType"FREE" | "ONSITE_PAYMENT" | "PREPAID_STRIPE"
        • requiresApprovalboolean
        • discountPercentnumber | null
        • discountAmountnumber | null
        • discountedPricenumber
    • |2object
      • validfalse
      • codestring
      • errorCodestring
  • invitationCheckedboolean
  • recordobject
    • revisioninteger≥0
    • status"none" | "request_started" | "checkout_started" | "registered"
    • operationState"idle" | "submitting" | "unknown" | "completed"
    • operationIdstring(uuid) | null
    • ticketIdstring | null
    • ticketNamestring | null
    • entryStatestring | null
    • verifiedboolean
    • registeredboolean
    • networkingReadyboolean
    • accessSource"ticket" | "staff_pass" | null
  • ticketModules任意true

失敗したとき(エラー)

失敗したときの状態コードと、その意味。本文の 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 を参照)
  • 502HTTP 502(x-bounty-error-codes を参照)
  • 503HTTP 503(x-bounty-error-codes を参照)

呼び出しの見本

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

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