コンテンツにスキップ

申し込み

これらのエンドポイントは、Crewcade でサインインで得たメンバートークンで使います。トークンに registrations スコープが必要です。APIキーは使えません。

アプリは、メンバーを無料チケットに申し込ませられます。無料の申し込みをキャンセルすることもできます。有料チケットは Crewcade のイベントページで扱います。アプリはメンバーをそこへ送ります。

メンバーの申し込みを一覧する

Section titled “メンバーの申し込みを一覧する”
GET /me/registrations
クエリ型意味
whenstringupcoming または past。初期値は upcoming です。
statusstring残すステータスを、カンマで区切って入れます。pending、confirmed、waitlisted、cancelled、no_show から選びます。初期値はすべてです。
pagenumber読むページ。1 から始まります。初期値は 1 です。
pageSizenumber1 ページの申し込み数。1 から 100 です。初期値は 20 です。
  • upcoming は、開始時刻がこれからのものです。早い順です。
  • past は、開始時刻が過ぎたものです。新しい順です。
  • 開催中のイベントは past に入ります。

申し込みには次のフィールドがあります。

フィールド意味
id申し込みの id。
statuspending、confirmed、waitlisted、cancelled、no_show のどれかです。
registeredAtメンバーが申し込んだ時刻。
cancelledAtメンバーがキャンセルした時刻。キャンセルしていなければ null です。
tierチケット。id、name、nameText。null のこともあります。
paymentStatenone、awaiting、paid、refunded、refund_owed のどれかです。none は、無料、または支払いに失敗したことを表します。
event日程。id、seriesId、publicId、urlKey、title、titleText、start、end、status、coverImageUrl。
GET /events/{id}/registration

1 つの日程の id を渡します。その日程のメンバーの申し込みが返ります。メンバーが申し込んでいなければ、404 と not_registered が返ります。

POST /events/{id}/registration

無料チケットだけです。メンバーが無料チケットを複数選べるときは、JSON の本文で tierId を送ります。ティアは GET /events/{id} で読みます。イベント APIを見てください。

  • 1 回目の呼び出しは、201 と申し込みを返します。
  • 2 回目の呼び出しは、200 と同じ申し込みを返します。

無料の申し込みをキャンセルする

Section titled “無料の申し込みをキャンセルする”
DELETE /events/{id}/registration

本文なしの 204 が返ります。すでにキャンセルした申し込みをキャンセルしても 204 です。

エラーの本文には、いつも code と message があります。

ステータスコード意味
400tier_requiredメンバーは無料チケットを複数選べます。tierId を送ってください。本文に tierIds が入ります。
400tier_not_availableこのチケットは、この日程では販売されていません。
400event_pastその日程はすでに始まっています。
400registration_refusedクラブはこの申し込みを受け付けません。理由は message にあります。
401invalid_tokenトークンが正しくありません。
403insufficient_scopeトークンに registrations スコープがありません。
403TICKET_TIER_ROLE_RESTRICTEDこのチケットは、特定のロールのメンバーだけのものです。
404not_registeredメンバーは、この日程に申し込んでいません。
404event_not_foundイベントが存在しないか、メンバーが開けません。
404event_is_series繰り返しシリーズの id を送っています。1 つの日程の id を送ってください。
409payment_requiredチケットは有料です。本文の eventUrl にメンバーを送ってください。
409form_requiredイベントが先に質問をします。本文の eventUrl にメンバーを送ってください。
409event_fullイベントに空席がありません。
409tier_sold_outこのチケットに空席がありません。
409refund_open前のチケットの返金がまだ終わっていません。メンバーを eventUrl に送ってください。
409already_registeredメンバーは、この日程にすでに申し込んでいます。eventUrl を見てください。
409cancel_on_event_pageチケットは有料か、ほかの人と一緒に買ったものです。メンバーは eventUrl でキャンセルします。
429rate_limitedリクエストが多すぎます。Retry-After ヘッダーの秒数だけ待ってください。