本文へ移動
Bounty Developer

GET/api/planning/speakers/{id}

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

要約

登壇者 1 人: 今の掲載内容・開いている提案と本人の直し・結んだアカウント・出るコンテンツ・限定リンク・今の上限

呼び方と印

ログイン・レート制限

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

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

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

  • idpath必須string(uuid)

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

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

  • revinteger≥0
  • speakerobject
    • idstring(uuid)
    • state"draft" | "proposed" | "edited" | "confirmed"
    • profileobject
      • namestring
      • kanastring | null
      • titlestring | null
      • companystring | null
      • biostring | null
      • photoImageIdstring(uuid) | null
      • nameEnstring | null
      • titleEnstring | null
      • companyEnstring | null
    • photoUrlstring | null
    • proposalobject | null
      • idstring(uuid)
      • state"proposed" | "edited" | "confirmed" | "withdrawn"
      • proposedobject
        • namestring
        • kanastring | null
        • titlestring | null
        • companystring | null
        • biostring | null
        • photoImageIdstring(uuid) | null
        • nameEnstring | null
        • titleEnstring | null
        • companyEnstring | null
      • editedobject | null
        • name任意string
        • kana任意string | null
        • title任意string | null
        • company任意string | null
        • bio任意string | null
        • photoImageId任意string(uuid) | null
        • nameEn任意string | null
        • titleEn任意string | null
        • companyEn任意string | null
      • effectiveobject
        • namestring
        • kanastring | null
        • titlestring | null
        • companystring | null
        • biostring | null
        • photoImageIdstring(uuid) | null
        • nameEnstring | null
        • titleEnstring | null
        • companyEnstring | null
      • changedKeysarray<enum(9)>
      • photoUrlstring | null
      • proposedByobject | null
        • userIdstring(uuid)
        • displayNamestring
        • avatarUrlstring | null
      • createdAtstring(date-time)
      • editedAtstring(date-time) | null
      • confirmedAtstring(date-time) | null
    • accountobject | null
      • userIdstring(uuid)
      • displayNamestring
      • avatarUrlstring | null
    • confirmedAtstring(date-time) | null
    • contentsarray<object>
      • contentIdstring(uuid)
      • eventIdstring(uuid)
      • titlestring
      • status"draft" | "published"
      • startsAtstring(date-time) | null
      • endsAtstring(date-time) | null
      • roomIdstring(uuid) | null
      • roomNamestring | null
      • roleenum(5)"speaker" "moderator" "host" "judge" "lt"
      • featuredboolean
    • linksarray<object>
      • idstring(uuid)
      • contentIdstring(uuid)
      • canEditboolean
      • activeboolean
      • claimedboolean
      • expiresAtstring(date-time)
      • revokedAtstring(date-time) | null
      • lastOpenedAtstring(date-time) | null
      • createdAtstring(date-time)
    • limitsobject
      • nameinteger
      • kanainteger
      • titleinteger
      • companyinteger
      • biointeger
      • nameEninteger
      • titleEninteger
      • companyEninteger

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の 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
  • speaker_not_found

呼び出しの見本

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

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