> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# POST (/handles/query)

> POST (/handles/query)

# POST (/handles/query)

セッション ハンドルに対するクエリを作成します。

> **重要:**\
> このメソッドは 2015 Multiplayer で使用され、そのマルチプレイヤー バージョン以降にのみ適用されます。テンプレート コントラクト 104/105 以降での使用を意図しており、すべてのリクエストにヘッダー要素 X-Xbl-Contract-Version: 104/105 以降が必要です。

* [解説](#ID4ET)
* [URI パラメーター](#ID4EDB)
* [クエリ文字列パラメーター](#ID4EQB)
* [HTTP ステータス コード](#ID4EBF)
* [リクエスト本文](#ID4EIF)
* [レスポンス本文](#ID4ETF)

## 解説

この HTTP/REST メソッドは、セッション情報を含まないハンドル データのみに対するクエリを作成します。**Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetActivitiesForSocialGroupAsync** によってラップできます。

このメソッドのリクエスト本文の type フィールドは "activity" に設定する必要があります。レスポンス本文の項目は **MultiplayerActivityDetails** のプロパティに直接マッピングされます。

## URI パラメーター

## クエリ文字列パラメーター

クエリは、次の表のクエリ文字列パラメーターを使用して変更できます。

\| **パラメーター**| **型**| **説明**|
\| --- | --- | --- | --- |
\| keyword| string| 取得対象のセッションまたはテンプレートに含まれている必要のあるキーワード (例: "foo")。 |
\| xuid| 64-bit unsigned integer| クエリに含めるセッションの XBOX ユーザー ID (例: "123")。既定では、ユーザーがセッションに含まれるためには、そのセッションでアクティブである必要があります。 |
\| reservations| boolean| ユーザーが予約プレイヤーとして設定されているがアクティブ プレイヤーとして参加していないセッションを含めるには true。このパラメーターは、自分自身のセッションを問い合わせる場合、または特定のユーザーのセッションをサーバー間で問い合わせる場合にのみ使用されます。 |
\| inactive| boolean| ユーザーが承諾しているがアクティブにプレイしていないセッションを含めるには true。ユーザーが "ready" だが "active" でないセッションは非アクティブとしてカウントされます。 |
\| private| boolean| プライベート セッションを含めるには true。このパラメーターは、自分自身のセッションを問い合わせる場合、または特定のユーザーのセッションをサーバー間で問い合わせる場合にのみ使用されます。 |
\| visibility| string| セッションの可視性の状態。可能な値は **MultiplayerSessionVisibility** で定義されています。このパラメーターが "open" に設定されている場合、クエリはオープン セッションのみを含める必要があります。"private" に設定されている場合は、*private* パラメーターを true に設定する必要があります。 |
\| version| 32-bit signed integer| 含める最大セッション バージョン。たとえば、値 2 は、メジャー セッション バージョンが 2 以下のセッションのみを含めるように指定します。バージョン番号は、リクエストのコントラクト バージョンを 100 で割った剰余以下である必要があります。 |
\| take| 32-bit signed integer| 取得するセッションの最大数。この数は 0 から 100 の間である必要があります。 |

*private* または *reservations* のいずれかを true に設定するには、セッションに対するサーバー レベル アクセス権が必要です。あるいは、これらの設定には、呼び出し元の XUID クレームが URI 内の XUID フィルターと一致することが必要です。それ以外の場合、該当するセッションが実際に存在するかどうかにかかわらず、HTTP/403 ステータス コードが返されます。

## HTTP ステータス コード

サービスは、MPSD に適用される HTTP ステータス コードを返します。

## リクエスト本文

ユーザーの "favorites" ソーシャル グラフに対するすべてのアクティビティの場合、リクエスト本文は次のようになります。

```cpp theme={null}
{
  "type": "activity",
  "scid": "B5B1F71F-A328-4371-89E0-C3AD222D0E92"  // optional filter on scid
  "owners": {
    "people": {
      "moniker": "favorites",
      "monikerXuid": "3210"
    }
  }
}

```

## レスポンス本文

ハンドルは、それぞれの構造体に一意の ID が埋め込まれたハンドル構造体の配列として取得されます。

```cpp theme={null}
{
  "results": [
    {
      "id": "11111111-ebe0-42da-885f-033860a818f6",
      "type": "activity",
      "version": 1,
      "sessionRef": {
        "scid": "8dfb0100-ebe0-42da-885f-033860a818f6",
        "templateName": "party",
        "name": "e3a836aeac6f4cbe9bcab985494d3175"
      },
      "titleId": "1234567",
      "ownerXuid": "3212",
      {
        "id": "11111111-ebe0-42da-885f-033860a818f7",
      "type": "activity",
      "version": 1,
      "sessionRef": {
         "scid": "8dfb0100-ebe0-42da-885f-033860a818f6",
        "templateName": "TitleStorageTestDefault",
        "name": "795fcaa7-8377-4281-bd7e-e86c12843632"
      },
      "titleId": "1234567",
      "ownerXuid": "3212",
    }
  }]
}

```

## 関連項目

##### 親

[/handles/query](https://docs.xbox.com/ja-jp/reference/live/rest/uri/sessiondirectory/uri-handlesquery.md)


## Related topics

- [/handles/query](https://docs.xbox.com/ja-jp/reference/live/rest/uri/sessiondirectory/uri-handlesquery.md)
- [POST (/handles/query?include=relatedInfo)](https://docs.xbox.com/ja-jp/reference/live/rest/uri/sessiondirectory/uri-handlesqueryincludepost.md)
- [POST (/handles)](https://docs.xbox.com/ja-jp/reference/live/rest/uri/sessiondirectory/uri-handlespost.md)
- [POST /titles/{titleId}/activities/query](https://docs.xbox.com/ja-jp/reference/live/rest/uri/multiplayeractivity/swagger-uris/uri-ExternalGetActivityBatch.md)
- [XStoreCloseProductsQueryHandle](https://docs.xbox.com/ja-jp/reference/system/xstore/functions/xstorecloseproductsqueryhandle.md)