> ## 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 (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/batch)

> POST (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/batch)

# POST (/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/batch)

Cria uma consulta em lote em várias IDs de usuário do XBOX.

> **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](#ID4EKB)
* [Parâmetros da cadeia de consulta](#ID4EVB)
* [Códigos de status HTTP](#ID4EGF)
* [Corpo da solicitação](#ID4ENF)
* [Corpo da resposta](#ID4EWF)

<a id="ID4ET" />

## Comentários

Este método HTTP/REST cria consultas em lote em várias IDs de usuário do XBOX no nível do modelo de sessão. Este método pode ser encapsulado por **Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetSessionsForUsersFilterAsync**.

Para o Multiplayer 2015, você pode combinar várias consultas em uma única chamada se todas as consultas forem iguais, mas tratarem de IDs de usuário do XBOX (XUIDs) diferentes, conforme representado no parâmetro de cadeia de consulta *xuid*. Observe que os parâmetros da cadeia de consulta e as respostas são os mesmos para consultas regulares e consultas em lote.

Para uma consulta em lote, as sessões pertencentes a cada XUID são gravadas na resposta na mesma ordem em que os parâmetros *xuid* são apresentados na solicitação. É possível que a mesma sessão apareça várias vezes na resposta, uma vez para cada *xuid* ao qual ela corresponde.

<a id="ID4EKB" />

## Parâmetros de URI

\| Parâmetro| Tipo| Descrição|
\| --- | --- | --- | --- |
\| scid| GUID| Identificador de configuração de serviço (SCID). Parte 1 do identificador da sessão.|
\| sessionTemplateName| string| Nome da instância atual do modelo de sessão. Parte 2 do identificador da sessão.|

<a id="ID4EVB" />

## 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="ID4EGF" />

## Códigos de status HTTP

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

<a id="ID4ENF" />

## Corpo da solicitação

```cpp theme={null}
{ "xuids": [ "1234", "5678" ] }

```

<a id="ID4EWF" />

## Corpo da resposta

O retorno deste método é uma matriz JSON de referências de sessão, com alguns dados de sessão incluídos embutidos.

```cpp theme={null}
{
    "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" ]
    }
  ]
}
```

<a id="ID4EDG" />

## Confira também

<a id="ID4EFG" />

##### Pai

[/serviceconfigs/{scid}/sessiontemplates/{sessionTemplateName}/batch](/pt-BR/reference/live/rest/uri/sessiondirectory/uri-serviceconfigscidsessiontemplatessessiontemplatenamebatch)


## Related topics

- [XblMultiplayerSessionReferenceUri](/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionreferenceuri.md)
- [Multiplayer Session Directory overview](/services/xbox-services/multiplayer/mpsd/live-mpsd-overview.md)
