/serviceconfigs/{scid}/sessions
セッションのドキュメントのセットを取得するための GET 操作をサポートします。
ドメイン
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| scid | GUID | サービス構成 ID (SCID)。 セッション ID のパート 1。 |
| キーワード | 文字列 | 結果をフィルター処理し、指定の文字列で識別されるセッションだけを得るために使用されるキーワード。 |
| xuid | GUID | セッションの取得対象となるユーザーの Xbox ID。 ユーザーは、セッションでアクティブである必要があります。 |
| reservations | 文字列 | ユーザーが承諾していないセッションがセッションの一覧に含まれているかどうかを示す値。 このパラメーターは TRUE にだけ設定することができます。 この設定では、呼び出し元がセッションに対するサーバー レベルのアクセス権を持っているか、呼び出し元の XUID クレームが Xbox ユーザー ID フィルターに一致している必要があります。 |
| inactive | 文字列 | ユーザーは承諾したが積極的にプレイしていないセッションがセッションの一覧に含まれているかどうかを示す値。 このパラメーターは TRUE にだけ設定することができます。 |
| private | 文字列 | セッションの一覧にプライベート セッションが含まれているかどうかを示す値。 このパラメーターは TRUE にだけ設定することができます。 独自のセッションをクエリする場合、またはサーバー間でクエリする場合にのみ有効です。 このパラメーターを true に設定する場合は、呼び出し元がセッションに対するサーバー レベルのアクセス権を持っているか、呼び出し元の XUID クレームが Xbox ユーザー ID フィルターに一致している必要があります。 |
| visibility | 文字列 | フィルター処理の結果で使用される可視性の状態を示す列挙値。 現在このパラメーターは、開いているセッションを含める Open にのみ設定できます。 「MultiplayerSessionVisibility」を参照してください。 |
| version | 文字列 | 含めるセッションのメジャー セッション バージョン (またはそれ未満) を示す正の整数。 値は、要求のコントラクト バージョンを 100 で割った余り以下でなければなりません。 |
| take | 文字列 | 取得するセッションの最大数を示す正の整数。 |
有効なメソッド
GET (/serviceconfigs/{scid}/sessions)
指定されたセッション情報を取得します。