本文へ移動
Bounty Developer

PUT/api/availability

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

要約

「今会えます」を出す（出し直し = 上書き）。長さは 15 分の固定で、イベント終了を越えない（durationMin は互換のため受け取るが無視する）。pin は現在の会場図の場所（任意）

呼び方と印

ログイン・レート制限

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

送るもの（本文）application/json

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

  • note任意string | null
    長さ ≤120
  • pin任意object | null
  • mapId必須string(uuid)
  • x必須number
    0–1
  • y必須number
    0–1
  • label必須string
    長さ 1–60
  • durationMin任意integer | null
    ≤1440

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

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

  • availabilityobject
    • notestring | null
    • pinobject | null
      • mapIdstring
      • xnumber
      • ynumber
      • labelstring
    • expiresAtstring
    • updatedAtstring
    • remainingMininteger
    • listedboolean

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 429レート制限（Retry-After 付き）
  • invalid_input
  • note_too_long
  • invalid_map_pin
  • unknown_map
  • stale_map
  • event_ended
  • rate_limited

呼び出しの見本

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

curl -X PUT "https://bounty.spikes.4s.link/api/availability" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{}'
PUT /api/availability | Bounty Developer