本文へ移動
Bounty Developer

PUT/api/planning/blocks/{contentId}/speakers

「コンテンツ企画」の分類の、送った内容で対象を保存する（更新する）API。ログインした本人として呼ぶ。

要約

コンテンツの登壇者の全文（並び・役割・大きく見せる人）。ここに無い人は外す

呼び方と印

ログイン・レート制限

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

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

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

  • contentIdpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • expectedRevision必須string
    長さ 1–40
  • speakers必須array<object>
    件数 ≤12
  • speakerId必須string(uuid)
  • role任意enum(5)
    • "speaker"
    • "moderator"
    • "host"
    • "judge"
    • "lt"
    既定 "speaker"
  • featured任意boolean
    既定 false

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

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

  • revinteger≥0
  • blockobject
    • 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)

失敗したとき（エラー）

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

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

呼び出しの見本

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

curl -X PUT "https://bounty.spikes.4s.link/api/planning/blocks/{contentId}/speakers" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "expectedRevision": "string",
    "speakers": []
  }'
PUT /api/planning/blocks/{contentId}/speakers | Bounty Developer