本文へ移動
Bounty Developer

GET/api/participation-visual/events/{eventId}/display-image

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

要約

本人の公開参加表明に使う顔写真・背景素材だけ（合成なし）

呼び方と印

ログイン

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

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

  • eventIdpath必須string(uuid)
  • expectedActorIdquery必須string(uuid)
  • expectedPublishedRevisionquery必須integer
    ≥0
  • kindquery必須"avatar" | "background"

返るもの（応答）200 · image/webp

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • unauthorized
  • invalid_token
  • invalid_origin
  • invalid_input
  • payload_too_large
  • forbidden
  • consent_required
  • actor_changed
  • event_not_found
  • visual_revision_conflict
  • background_not_owned_by_event
  • background_unavailable
  • rate_limited
  • visual_disabled
  • event_not_active
  • image_not_found

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/participation-visual/events/{eventId}/display-image?expectedActorId=00000000-0000-4000-8000-000000000000&expectedPublishedRevision=0&kind=avatar" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/participation-visual/events/{eventId}/display-image | Bounty Developer