GET (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName})
セッション オブジェクトを取得します。
重要:
この URI メソッドでは、すべての要求でヘッダー要素 X-Xbl-Contract-Version: に 104/105 以降を指定する必要があります。
解説
この HTTP/REST メソッドは、指定された名前のセッション ドキュメントを読み込み、セッションを取得します。 成功すると、サーバーから取得したセッション オブジェクトを、そのすべての属性と共に返します。 このメソッドは、Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetCurrentSessionAsync でラップすることができます。 GET メソッドのパラメーターは、セッションの MultiplayerSessionReference オブジェクトで指定され、GetCurrentSessionAsync の sessionReference パラメーターで渡されるパラメーターと直接対応しています。
GET メソッドのワイヤ形式を次に示します。
GET /serviceconfigs/00000000-0000-0000-0000-000000000000/sessiontemplates/quick/sessions/00000000-0000-0000-0000-000000000001 HTTP/1.1
Content-Type: application/json
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| scid | GUID | サービス構成 ID (SCID)。 セッション識別子の 1 番目の部分です。 |
| sessionTemplateName | 文字列 | セッション テンプレートの現在のインスタンスの名前です。 セッション識別子の 2 番目の部分です。 |
| sessionName | GUID | セッションの一意の ID。 セッション識別子の 3 番目の部分です。 |
HTTP ステータス コード
サービスは、MPSD に適用される HTTP ステータス コードを返します。
リクエストの本文
この要求の本体で送信されるオブジェクトはありません。
応答の本文
「MultiplayerSession (JSON)」の応答の構造を参照してください。
関連項目
親
/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/sessions/{sessionName}