本文へ移動
Bounty Developer

GET/api/availability

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

要約

今会える人（新しく出した順・場所とひとこと・残り分）と自分の「今会えます」。scope=mine は自分だけ。rev は分の区切りを含む（期限切れでも進む）。ETag / 304

呼び方と印

ログイン・ポーリング

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

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

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

  • scopequery任意"all" | "mine"
  • limitquery任意integer
    1–200

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

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

  • revinteger
  • nowstring
  • eventobject
    • startsAtstring
    • endsAtstring
    • timezonestring
    • phase"before" | "during" | "after"
  • mineobject | null
    • notestring | null
    • pinobject | null
      • mapIdstring
      • xnumber
      • ynumber
      • labelstring
    • expiresAtstring
    • updatedAtstring
    • remainingMininteger
    • listedboolean
  • peoplearray<object>
    • todayLook任意object | null
      • idstring
      • imageUrlstring
      • notestring | null
    • userIdstring
    • displayNamestring
    • avatarUrlstring | null
    • titlestring | null
    • orgNamestring | null
    • notestring | null
    • pinobject | null
      • mapIdstring
      • xnumber
      • ynumber
      • labelstring
    • expiresAtstring
    • remainingMininteger
  • durationsarray<integer>

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い

呼び出しの見本

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

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