本文へ移動
Bounty Developer

GET/api/events/{slug}/tickets/versions/{versionId}

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

要約

チケットの設問の公開版(申し込みのページ)

呼び方と印

ログイン

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

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

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

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

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

  • versionobject
    • versionIdstring(uuid)
    • questionnaireIdstring(uuid)
    • eventIdstring(uuid)
    • versioninteger
    • documentobject
      • pagesarray<object>
        • idstring/^p_[a-z0-9]{4,24}$/
        • destination"fours_common" | "bounty_profile" | "bounty_event"
        • placement"before_checkout" | "after_checkout"
        • titlestring長さ 1–80
        • modulesarray<object>
          • refIdstring
          • moduleIdstring(uuid) | null
          • revisioninteger | null
          • bodyobject
            • titlestring長さ 1–80
            • helpany
            • questionsarray<any>件数 1–30

失敗したとき(エラー)

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

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

呼び出しの見本

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

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