申し込み
これらのエンドポイントは、Crewcade でサインインで得たメンバートークンで使います。トークンに registrations スコープが必要です。APIキーは使えません。
アプリは、メンバーを無料チケットに申し込ませられます。無料の申し込みをキャンセルすることもできます。有料チケットは Crewcade のイベントページで扱います。アプリはメンバーをそこへ送ります。
メンバーの申し込みを一覧する
Section titled “メンバーの申し込みを一覧する”GET /me/registrations| クエリ | 型 | 意味 |
|---|---|---|
when | string | upcoming または past。初期値は upcoming です。 |
status | string | 残すステータスを、カンマで区切って入れます。pending、confirmed、waitlisted、cancelled、no_show から選びます。初期値はすべてです。 |
page | number | 読むページ。1 から始まります。初期値は 1 です。 |
pageSize | number | 1 ページの申し込み数。1 から 100 です。初期値は 20 です。 |
upcomingは、開始時刻がこれからのものです。早い順です。pastは、開始時刻が過ぎたものです。新しい順です。- 開催中のイベントは
pastに入ります。
申し込みには次のフィールドがあります。
| フィールド | 意味 |
|---|---|
id | 申し込みの id。 |
status | pending、confirmed、waitlisted、cancelled、no_show のどれかです。 |
registeredAt | メンバーが申し込んだ時刻。 |
cancelledAt | メンバーがキャンセルした時刻。キャンセルしていなければ null です。 |
tier | チケット。id、name、nameText。null のこともあります。 |
paymentState | none、awaiting、paid、refunded、refund_owed のどれかです。none は、無料、または支払いに失敗したことを表します。 |
event | 日程。id、seriesId、publicId、urlKey、title、titleText、start、end、status、coverImageUrl。 |
1 つの申し込みを読む
Section titled “1 つの申し込みを読む”GET /events/{id}/registration1 つの日程の id を渡します。その日程のメンバーの申し込みが返ります。メンバーが申し込んでいなければ、404 と not_registered が返ります。
メンバーを申し込ませる
Section titled “メンバーを申し込ませる”POST /events/{id}/registration無料チケットだけです。メンバーが無料チケットを複数選べるときは、JSON の本文で tierId を送ります。ティアは GET /events/{id} で読みます。イベント APIを見てください。
- 1 回目の呼び出しは、
201と申し込みを返します。 - 2 回目の呼び出しは、
200と同じ申し込みを返します。
無料の申し込みをキャンセルする
Section titled “無料の申し込みをキャンセルする”DELETE /events/{id}/registration本文なしの 204 が返ります。すでにキャンセルした申し込みをキャンセルしても 204 です。
エラーの本文には、いつも code と message があります。
| ステータス | コード | 意味 |
|---|---|---|
| 400 | tier_required | メンバーは無料チケットを複数選べます。tierId を送ってください。本文に tierIds が入ります。 |
| 400 | tier_not_available | このチケットは、この日程では販売されていません。 |
| 400 | event_past | その日程はすでに始まっています。 |
| 400 | registration_refused | クラブはこの申し込みを受け付けません。理由は message にあります。 |
| 401 | invalid_token | トークンが正しくありません。 |
| 403 | insufficient_scope | トークンに registrations スコープがありません。 |
| 403 | TICKET_TIER_ROLE_RESTRICTED | このチケットは、特定のロールのメンバーだけのものです。 |
| 404 | not_registered | メンバーは、この日程に申し込んでいません。 |
| 404 | event_not_found | イベントが存在しないか、メンバーが開けません。 |
| 404 | event_is_series | 繰り返しシリーズの id を送っています。1 つの日程の id を送ってください。 |
| 409 | payment_required | チケットは有料です。本文の eventUrl にメンバーを送ってください。 |
| 409 | form_required | イベントが先に質問をします。本文の eventUrl にメンバーを送ってください。 |
| 409 | event_full | イベントに空席がありません。 |
| 409 | tier_sold_out | このチケットに空席がありません。 |
| 409 | refund_open | 前のチケットの返金がまだ終わっていません。メンバーを eventUrl に送ってください。 |
| 409 | already_registered | メンバーは、この日程にすでに申し込んでいます。eventUrl を見てください。 |
| 409 | cancel_on_event_page | チケットは有料か、ほかの人と一緒に買ったものです。メンバーは eventUrl でキャンセルします。 |
| 429 | rate_limited | リクエストが多すぎます。Retry-After ヘッダーの秒数だけ待ってください。 |