リファラル子孫(招待ツリー)
GET
/events/:eventId/entries/:entryId/referral-descendants指定参加登録を根として招待ツリーを下方向に展開します。各ノードの直接の子は childrenLimit + cursor でページングされ、子の総数(CONFIRMED / CHECKED_IN のみ)も返します。呼び出しユーザーが確定参加者でない場合は 403 です。
| 認証 | 要ログイン |
|---|
パスパラメータ
eventIdstring必須イベント ID
entryIdstring必須根となる参加登録 ID
クエリパラメータ
generationsnumber下方向に展開する深さ。デフォルト 10(1〜50 にクランプ)
childrenLimitnumber各ノードごとの直接の子の最大返却件数。デフォルト 20(1〜100 にクランプ)
cursorstring子一覧の続き取得用の不透明カーソル(不正時は 400)
レスポンス
| フィールド | 型 | 説明 |
|---|---|---|
entryId | string | 根の参加登録 ID |
entry | object | 根ノード。各ノードに children / childrenTotalCount / childrenNextCursor を含む(再帰) |
リクエスト
curl https://api.4s.link/events/EVENT_ID/entries/:entryId/referral-descendants \-H "Authorization: Bearer 4s_at_..."
レスポンス例
{"entryId": "550e8400-...","entry": {"id": "550e8400-...","invitedByEntryId": null,"invitationGeneration": null,"invitationRootEntryId": null,"user": { "id": "9b2c3d4e-...", "slug": "alice-yamada", "firstName": "Alice", "lastName": "Yamada" },"ticketName": "一般参加","children": [{"id": "660e9511-...","invitedByEntryId": "550e8400-...","invitationGeneration": 1,"invitationRootEntryId": "550e8400-...","user": { "id": "1a2b3c4d-...", "slug": "bob-sato", "firstName": "Bob", "lastName": "Sato" },"ticketName": "招待参加","children": [],"childrenTotalCount": 0,"childrenNextCursor": null}],"childrenTotalCount": 3,"childrenNextCursor": "eyJ2IjoxLCJwYXJlbnRFbnRyeUlkIjoiNTUwZTg0MDAtLi4uIn0"}}