本文へ移動
Bounty Developer

GET/api/events/{slug}/trio

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

要約

選択イベントのTRIO。現在の資格と本人・設定版を照合

呼び方と印

ログイン・ポーリング

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

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

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

  • slugpath必須string
  • expectedEventIdquery必須string(uuid)
  • expectedActorIdquery必須string(uuid)
  • expectedRevisionquery必須string
    /^[a-f0-9]{64}$/

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

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

  • revinteger
  • nowstring
  • enabledboolean
  • proposalsarray<object>
    • idstring
    • status"proposed" | "active" | "closed"
    • axisKeystring
    • axisKind"attribute" | "purpose" | "want" | "wish"
    • axisNamestring
    • reasonstring
    • reasonDetailarray<object>
      • axisKeystring
      • valuestring
      • labelstring
      • reasonstring
    • conversationIdstring | null
    • membersarray<object>
      • idstring
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • state"pending" | "revealed" | "skipped" | "joined"
      • via"engine" | "added" | "merge"
      • isMeboolean
    • myState"pending" | "revealed" | "skipped" | "joined"
    • parentTrioIdsarray<string> | null
    • createdAtstring
    • activatedAtstring | null
    • expiresAtstring
  • activearray<object>
    • idstring
    • status"proposed" | "active" | "closed"
    • axisKeystring
    • axisKind"attribute" | "purpose" | "want" | "wish"
    • axisNamestring
    • reasonstring
    • reasonDetailarray<object>
      • axisKeystring
      • valuestring
      • labelstring
      • reasonstring
    • conversationIdstring | null
    • membersarray<object>
      • idstring
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • state"pending" | "revealed" | "skipped" | "joined"
      • via"engine" | "added" | "merge"
      • isMeboolean
    • myState"pending" | "revealed" | "skipped" | "joined"
    • parentTrioIdsarray<string> | null
    • createdAtstring
    • activatedAtstring | null
    • expiresAtstring
  • linksarray<object>
    • idstring
    • status"proposed" | "mutual" | "declined" | "expired"
    • axisKeystring
    • axisNamestring
    • reasonstring
    • mineobject
      • trioIdstring
      • reasonstring
      • membersarray<object>
        • idstring
        • displayNamestring
        • avatarUrlstring | null
        • titlestring | null
        • orgNamestring | null
      • acceptedboolean
    • theirsobject
      • trioIdstring
      • reasonstring
      • membersarray<object>
        • idstring
        • displayNamestring
        • avatarUrlstring | null
        • titlestring | null
        • orgNamestring | null
      • acceptedboolean
    • mergedTrioIdstring | null
    • mergedConversationIdstring | null
    • createdAtstring
  • eventIdstring(uuid)
  • actorIdstring(uuid)
  • settingsRevisionstring/^[a-f0-9]{64}$/

失敗したとき（エラー）

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

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）

呼び出しの見本

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

curl "https://bounty.spikes.4s.link/api/events/{slug}/trio?expectedEventId=00000000-0000-4000-8000-000000000000&expectedActorId=00000000-0000-4000-8000-000000000000&expectedRevision=string" \
  -H "Authorization: Bearer $BEARER_AUTH"
GET /api/events/{slug}/trio | Bounty Developer