本文へ移動
Bounty Developer

GET/api/planning/{eventId}

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

要約

企画の全体（日・ステージ・ライン・全コンテンツ〔未配置と終日のブースを含む〕・登壇者の一覧・格子の設定・rev）を 1 回で

呼び方と印

ログイン・ポーリング・レート制限

画面が一定の間隔で呼び直す前提の API（ポーリング）。

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

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

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

  • eventIdpath必須string(uuid)

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

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

  • revinteger≥0
  • nowstring(date-time)
  • eventobject
    • idstring(uuid)
    • slugstring
    • titlestring
    • timezonestring
    • startsAtstring(date-time) | null
    • endsAtstring(date-time) | null
    • isPrimaryboolean
  • gridobject
    • slotMinutesinteger
    • dayStartstring/^([01]\d|2[0-3]):[0-5]\d$/
    • dayEndstring/^([01]\d|2[0-3]):[0-5]\d$/
  • daysarray<object>
    • datestring(date)
    • inEventboolean
    • timedinteger≥0
  • stagesarray<object>
    • idstring(uuid)
    • codestring
    • namestring
    • sortinteger
    • lineIdsarray<string(uuid)>
    • areaIdstring(uuid) | null
  • areasarray<object>
    • idstring(uuid)
    • parentIdstring(uuid) | null
    • kind"venue" | "floor"
    • namestring
    • sortinteger
  • linesarray<object>
    • idstring(uuid)
    • eventIdstring(uuid)
    • namestring
    • colorenum(7)"sand" "sky" "mint" "lilac" "rose" "lemon" "slate"
    • sortinteger
    • roomIdsarray<string(uuid)>
    • membersarray<object>
      • userIdstring(uuid)
      • displayNamestring
      • avatarUrlstring | null
      • role"lead" | "member"
      • autoJoinboolean
    • contentCountinteger≥0
  • formatsarray<object>
    • formatenum(17)"guild_market" "student_startup" "partner_market" "product_launch" "creative_showcase" "tech_talk" "save_the_world" "preference_blitz" "mini_blitz" "aufheben" "nomad" "stage" …+5
    • kind"stage" | "booth" | "experience"
    • labelstring
  • blocksarray<object>
    • idstring(uuid)
    • revisionstring長さ 1–40
    • kind"stage" | "booth" | "experience"
    • formatstring
    • formatLabelstring
    • contentLabelstring | null
    • titlestring
    • status"draft" | "published"
    • placement"timed" | "allday" | "unscheduled"
    • daystring(date) | null
    • startsAtstring(date-time) | null
    • endsAtstring(date-time) | null
    • roomIdstring(uuid) | null
    • lineIdstring(uuid) | null
    • sortinteger
    • speakersarray<object>
      • speakerIdstring(uuid)
      • roleenum(5)"speaker" "moderator" "host" "judge" "lt"
      • featuredboolean
      • sortinteger
    • openCallIdsarray<string(uuid)>
    • thumbnailobject
      • revinteger≥0
      • designedboolean
      • renderedRevinteger | null≥0
    • chatConversationIdstring(uuid) | null
    • boothobject | null
      • boothIdstring(uuid) | null
      • parentContentIdstring(uuid) | null
      • assignmentsarray<object>
        • daystring(date) | null
        • slotKeystring
        • numberstring | null
        • state"draft" | "confirmed"
    • updatedAtstring(date-time)
  • speakersarray<object>
    • idstring(uuid)
    • namestring
    • titlestring | null
    • companystring | null
    • photoUrlstring | null
    • profileState"draft" | "proposed" | "edited" | "confirmed"
    • hasAccountboolean
    • contentIdsarray<string(uuid)>
    • activeLinksinteger≥0

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 429レート制限（Retry-After 付き）
  • 501HTTP 501（x-bounty-error-codes を参照）
  • unauthorized
  • forbidden
  • event_not_found

呼び出しの見本

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

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