本文へ移動
Bounty Developer

POST/api/wall-consult/{eventId}/action

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

要約

気になる（公開後〜枠の終了）・当日の受付/列/担当者操作・気になるを送った人への5〜15分のミーティング提案（QR交換/得点は変更しない）

呼び方と印

ログイン・レート制限

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

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

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

  • eventIdpath必須string(uuid)

送るもの（本文）application/json

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

  • |1必須object
  • action必須"interest"
  • shiftId必須string(uuid)
  • |2必須object
  • action必須"checkin"
  • seatId必須string(uuid)
  • shiftId必須string(uuid)
  • token必須string
    長さ 32–128
  • |3必須object
  • action必須"queue"
  • entryId必須string(uuid)
  • rev必須integer
    ≥0
  • |4必須object
  • action必須"cancel"
  • entryId必須string(uuid)
  • rev必須integer
    ≥0
  • |5必須object
  • action必須"approve"
  • entryId必須string(uuid)
  • rev必須integer
    ≥0
  • |6必須object
  • action必須"call"
  • entryId必須string(uuid)
  • rev必須integer
    ≥0
  • |7必須object
  • action必須"propose"
  • entryId必須string(uuid)
  • rev必須integer
    ≥0
  • startsAt必須string(date-time)
  • minutes必須integer
    5–15
  • message任意string
    長さ ≤200
  • |8必須object
  • action必須"start"
  • entryId必須string(uuid)
  • rev必須integer
    ≥0
  • |9必須object
  • action必須"end"
  • entryId必須string(uuid)
  • rev必須integer
    ≥0
  • |10必須object
  • action必須"chat"
  • entryId必須string(uuid)
  • rev必須integer
    ≥0
  • |11必須object
  • action必須"pause"
  • shiftId必須string(uuid)
  • rev必須integer
    ≥0
  • |12必須object
  • action必須"resume"
  • shiftId必須string(uuid)
  • rev必須integer
    ≥0

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

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

  • entryobject | null
    • idstring(uuid)
    • shiftIdstring(uuid)
    • participantIdstring(uuid)
    • statusenum(6)"interested" "waiting" "called" "active" "ended" "cancelled"
    • revinteger≥0
    • interestedAtstring(date-time)
    • checkedInAtstring(date-time) | null
    • approvedAtstring(date-time) | null
    • calledAtstring(date-time) | null
    • startsAtstring(date-time) | null
    • endsAtstring(date-time) | null
    • endedAtstring(date-time) | null
    • conversationIdstring(uuid) | null
    • chatTag"壁打ち"
    • cancelledBy"participant" | "host" | null
  • shiftobject | null
    • idstring(uuid)
    • seatIdstring(uuid)
    • hostobject
      • idstring(uuid)
      • displayNamestring
      • avatarUrlstring | null
      • titlestring | null
      • orgNamestring | null
    • topicstring
    • startsAtstring(date-time)
    • endsAtstring(date-time)
    • daystring
    • receivingboolean
    • activeboolean
    • revinteger≥0
  • conversationIdstring(uuid) | null
  • meetRequestIdstring(uuid) | null

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の 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 を参照）
  • 410HTTP 410（x-bounty-error-codes を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 429HTTP 429（x-bounty-error-codes を参照）
  • event_not_found
  • not_participant
  • forbidden
  • blocked
  • consent_required
  • revision_conflict
  • wall_not_today
  • wall_not_receiving
  • wall_schedule_overlap
  • wall_reservation_overlap
  • wall_state_conflict
  • wall_qr_invalid
  • wall_slot_not_current
  • wall_shift_identity_changed
  • wall_time_outside_shift
  • wall_interest_required
  • wall_not_shift_host
  • wall_meeting_active
  • wall_meeting_duration
  • wall_shift_inactive
  • wall_entry_closed
  • wall_seat_identity_changed
  • wall_place_key_invalid
  • wall_place_key_taken
  • meeting_place_booth_conflict
  • actor_changed

呼び出しの見本

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

curl -X POST "https://bounty.spikes.4s.link/api/wall-consult/{eventId}/action" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "interest",
    "shiftId": "00000000-0000-4000-8000-000000000000"
  }'
POST /api/wall-consult/{eventId}/action | Bounty Developer