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

# POST (/handles/query)

> POST (/handles/query)

# POST (/handles/query)

Cria consultas de identificadores de sessão.

> **Importante:**\
> Este método é usado pelo Multiplayer 2015 e se aplica somente a essa versão multijogador e posteriores. Ele se destina ao uso com o contrato de modelo 104/105 ou posterior e requer um elemento de cabeçalho X-Xbl-Contract-Version: 104/105 ou posterior em todas as solicitações.

* [Comentários](#ID4ET)
* [Parâmetros de URI](#ID4EDB)
* [Parâmetros da cadeia de consulta](#ID4EQB)
* [Códigos de status HTTP](#ID4EBF)
* [Corpo da solicitação](#ID4EIF)
* [Corpo da resposta](#ID4ETF)

<a id="ID4ET" />

## Comentários

Este método HTTP/REST cria consultas somente de dados de identificadores, sem nenhuma informação de sessão. Ele pode ser encapsulado por **Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetActivitiesForSocialGroupAsync**.

O campo type no corpo da solicitação deste método deve ser definido como "activity". Os itens no corpo da resposta são mapeados diretamente para as propriedades de **MultiplayerActivityDetails**.

<a id="ID4EDB" />

## Parâmetros de URI

<a id="ID4EQB" />

## Parâmetros da cadeia de consulta

Uma consulta pode ser modificada usando os parâmetros da cadeia de consulta na tabela a seguir.

\| <b>Parâmetro</b>| <b>Tipo</b>| <b>Descrição</b>|
\| --- | --- | --- | --- |
\| keyword| string| Uma palavra-chave, por exemplo, "foo", que deve ser encontrada nas sessões ou nos modelos para que eles sejam recuperados. |
\| xuid| inteiro sem sinal de 64 bits| A ID de usuário do XBOX, por exemplo, "123", das sessões a serem incluídas na consulta. Por padrão, o usuário deve estar ativo na sessão para que ela seja incluída. |
\| reservations| booliano| True para incluir sessões nas quais o usuário está definido como um jogador reservado, mas ainda não ingressou para se tornar um jogador ativo. Este parâmetro é usado somente ao consultar suas próprias sessões ou ao consultar as sessões de um usuário específico de servidor para servidor. |
\| inactive| booliano| True para incluir sessões que o usuário aceitou, mas nas quais não está jogando ativamente. As sessões nas quais o usuário está "ready", mas não "active", contam como inativas. |
\| private| booliano| True para incluir sessões privadas. Este parâmetro é usado somente ao consultar suas próprias sessões ou ao consultar as sessões de um usuário específico de servidor para servidor. |
\| visibility| string| Estado de visibilidade das sessões. Os valores possíveis são definidos por <b>MultiplayerSessionVisibility</b>. Se este parâmetro for definido como "open", a consulta deverá incluir somente sessões abertas. Se for definido como "private", o parâmetro <i>private</i> deverá ser definido como true. |
\| version| inteiro com sinal de 32 bits| A versão máxima da sessão que deve ser incluída. Por exemplo, um valor de 2 especifica que somente as sessões com uma versão principal de sessão de 2 ou inferior devem ser incluídas. O número da versão deve ser menor ou igual à versão do contrato da solicitação mod 100. |
\| take| inteiro com sinal de 32 bits| O número máximo de sessões a serem recuperadas. Esse número deve estar entre 0 e 100. |

Definir *private* ou *reservations* como true requer acesso no nível do servidor à sessão. Como alternativa, essas configurações exigem que a declaração de XUID do chamador corresponda ao filtro de XUID no URI. Caso contrário, o código de status HTTP/403 será retornado, independentemente de essas sessões realmente existirem ou não.

<a id="ID4EBF" />

## Códigos de status HTTP

O serviço retorna um código de status HTTP conforme aplicável ao MPSD.

<a id="ID4EIF" />

## Corpo da solicitação

Para todas as atividades do grafo social "favorites" de um usuário, o corpo da solicitação tem esta aparência:

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

```

<a id="ID4ETF" />

## Corpo da resposta

Os identificadores são recuperados como uma matriz de estruturas de identificadores, com uma ID exclusiva inserida em cada estrutura.

```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",
    }
  }]
}

```

<a id="ID4E4F" />

## Confira também

<a id="ID4E6F" />

##### Pai

[/handles/query](/pt-BR/reference/live/rest/uri/sessiondirectory/uri-handlesquery)


## Related topics

- [XStoreCloseProductsQueryHandle](/reference/system/xstore/functions/xstorecloseproductsqueryhandle.md)
- [XStoreEnumerateProductsQuery](/reference/system/xstore/functions/xstoreenumerateproductsquery.md)