本文へ移動
Bounty Developer

GET/api/passes/events

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

要約

本人の有効パス候補と最終NFC書込み確認状態（準備中・参加資格不足を区別）

呼び方と印

ログイン

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

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

  • availability任意"not_configured" | "participation_required" | "available"
  • eventsarray<object>件数 ≤100
    • idstring(uuid)
    • titlestring長さ ≤300
    • slugstring長さ ≤200
    • checkedInboolean
    • needsConfirmationboolean
    • templateRevisioninteger0–2147483646
    • nfcEnabledboolean
    • nfc任意object
      • status"not_written" | "verified" | "needs_rewrite"
      • verifiedAtstring(date-time) | null
      • templateRevisioninteger | null0–2147483646
      • draftRevisioninteger | null0–2147483646

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 428HTTP 428（x-bounty-error-codes を参照）
  • consent_required
  • pass_human_action_required

呼び出しの見本

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

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