GET (/serviceconfigs/{scid}/sessions)
指定されたセッション情報を取得します。
重要:
このメソッドでは、すべての要求でヘッダー要素 X-Xbl-Contract-Version: に 104/105 以降を指定する必要があります。
解説
この HTTP/REST メソッドは、指定されたフィルターのセッション情報を取得します。 このメソッドは、Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsAsync でラップすることができます。
注:
2015 マルチプレイヤーの場合、このメソッドは Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsForUsersFilterAsync によって呼び出されます。
注:
このメソッドの呼び出しには、常に、キーワード、Xbox ユーザー ID のフィルター、またはその両方を含める必要があります。 呼び出し元が private および reservations パラメーターに対する適切なアクセス許可を持っていない場合、該当するセッションが実際に存在するかどうかにかかわらず、メソッドはエラーコード 403 Forbidden を返します。
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 | 文字列 | 取得するセッションの最大数を示す正の整数。 |
HTTP ステータス コード
サービスは、MPSD に適用される HTTP ステータス コードを返します。
リクエストの本文
この要求の本体で送信されるオブジェクトはありません。
応答の本文
このメソッドから返されるのはセッション参照の JSON 配列で、一部のセッション データはインラインで取り込まれます。
{
"results": [ {
"xuid": "9876", // If the session was found from a xuid, that xuid.
"startTime": "2009-06-15T13:45:30.0900000Z",
"sessionRef": {
"scid": "foo",
"templateName": "bar",
"name": "session-seven"
},
"accepted": 4, // Approximate number of non-reserved members.
"status": "active", // or "reserved" or "inactive". This is the state of the user in the session, not the session itself. Only present if the session was found using a xuid.
"visibility": "open", // or "private", "visible", or "full"
"joinRestriction": "local", // or "followed". Only present if 'visibility' is "open" or "full" and the session has a join restriction.
"myTurn": true, // Not present is the same as 'false'. Only present if the session was found using a xuid.
"keywords": [ "one", "two" ]
}
]
}