本文へ移動
Bounty Developer

POST/api/meets/requests/{id}/{action}

「出会い」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約

依頼への操作（本文は stamp と counter だけ）

呼び方と印

ログイン

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

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

  • idpath必須string(uuid)
  • actionpath必須enum(6)
    • "accept"
    • "decline"
    • "counter"
    • "cancel"
    • "stamp"
    • "arrived"

送るもの（本文）application/json

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

  • |1必須object
  • stamp必須enum(8)
    • "omw"
    • "in5"
    • "in15"
    • "later"
    • "where"
    • "wave"
    • "lost"
    • "sorry"
  • |2必須object
  • kind必須"plan" | "now"
  • meetingMode任意"onsite" | "online"
    既定 "onsite"
  • spotId任意string(uuid) | null
  • mapPin任意object | null
  • mapId必須string(uuid)
  • x必須number
    0–1
  • y必須number
    0–1
  • label必須string
    長さ 1–60
  • meetingPlaceId任意string(uuid) | null
  • placeText任意string | null
    長さ ≤60
  • proposedAt任意string(date-time) | null
  • message任意string | null
    長さ ≤200

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

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

  • revinteger
  • resultobject
    • idstring
    • newId任意string
    • statusenum(7)"proposed" "accepted" "declined" "countered" "canceled" "expired" "done"
    • metboolean
  • requestobject
    • meetingMode"onsite" | "online"
    • idstring
    • kind"plan" | "now"
    • statusenum(7)"proposed" "accepted" "declined" "countered" "canceled" "expired" "done"
    • direction"in" | "out"
    • meobject
      • idstring
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • catchphrasestring | null
      • wantedobject | null
        • bountynumber
    • otherobject
      • idstring
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
      • catchphrasestring | null
      • wantedobject | null
        • bountynumber
    • spotobject | null
      • idstring
      • namestring
      • descriptionstring | null
      • mapXnumber | null
      • mapYnumber | null
      • mapIdstring | null
      • tableCount任意integer1–999
    • mapPinobject | null
      • mapobject
        • idstring
        • namestring
        • widthinteger
        • heightinteger
        • urlstring
        • createdAtstring
      • xnumber
      • ynumber
      • labelstring
    • placeTextstring | null
    • proposedAtstring | null
    • expiresAtstring | null
    • messagestring | null
    • createdAtstring
    • respondedAtstring | null
    • parentIdstring | null
    • childIdstring | null
    • pingsarray<object>
      • idstring
      • from"me" | "other"
      • kind"stamp" | "arrived"
      • stampstring | null
      • createdAtstring
    • arrivedobject
      • meboolean
      • otherboolean
    • canrecord<boolean>
    • outcomeobject | null
      • createdboolean
      • pointsnumber
      • pointsEachnumber
      • bountynumber
      • otherobject
        • idstring
        • displayNamestring
        • avatarUrlstring | null
        • titlestring | null
        • orgNamestring | null
        • catchphrasestring | null
        • wantedobject | null
          • bountynumber
    • wall任意object | null
      • shiftIdstring
      • seatNamestring
      • placeLabelstring
      • minutesinteger5–15
      • startsAtstring
      • endsAtstring
      • shiftStartsAtstring
      • shiftEndsAtstring
      • timezonestring
      • hrefstring
    • table任意object | null
      • spotNamestring
      • tableNointeger | null≥1
      • placestring
      • labelstring
    • followup任意object | null
      • phase"open" | "closed"
      • closesAtstring
      • mineobject | null
        • metboolean
        • againboolean
      • mutualboolean
      • againobject | null
        • slotstring | null
        • spotIdstring | null
        • eventEndedboolean
        • conversationIdstring | null

失敗したとき（エラー）

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

  • 400入力の誤り（error = invalid_input など）
  • 401未ログイン（unauthorized）/ Bearer が無効（invalid_token。WWW-Authenticate 付き）
  • 403権限が無い
  • 409HTTP 409（x-bounty-error-codes を参照）
  • invalid_input
  • not_found
  • action_not_allowed
  • counter_required
  • unknown_spot
  • unknown_map
  • stale_map
  • place_required
  • time_required
  • time_in_past
  • time_too_far
  • wall_reservation_overlap

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/meets/requests/{id}/{action}" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "stamp": "omw"
  }'
POST /api/meets/requests/{id}/{action} | Bounty Developer