> ## 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.

# Obter lote de atividades

> Obter lote de atividades

# Obter lote de atividades

Obtém um lote de atividades multijogador para uma lista de usuários.

Essa API permite que clientes e serviços obtenham um lote de atividades para uma lista de usuários.

Essa API pode retornar resultados parciais; qualquer usuário terá seu conjunto completo de atividades, mas alguns usuários podem não ter nenhuma atividade. Se encontrarmos atividades para um subconjunto de usuários, nós as retornaremos. Para os usuários cujas atividades não foram encontradas, retornamos uma lista vazia para esse usuário. Para os usuários cujas atividades não puderam ser buscadas devido a um erro interno, retornamos null para esse usuário; o cliente deve repetir a chamada. Em resumo, um usuário pode ter uma lista de atividades, uma lista vazia ou null.

```http theme={null}
POST /titles/{titleId}/activities/query
```

<a id="uri-parameters" />

## Parâmetros de URI

| Parâmetro | Em | Obrigatório | Tipo | Descrição |
| - | - | - | - | - |
| titleId | path | TRUE | integer | O titleId do jogo para o qual a solicitação está sendo enviada. |

<a id="request-body" />

## Corpo da solicitação

| Nome | Obrigatório | Tipo | Descrição |
| - | - | - | - |
| users | TRUE | string\[] | As IDs dos usuários cujas informações de atividade precisam ser recuperadas. Há suporte para até 30 usuários. |

<a id="request-header" />

## Cabeçalho da solicitação

| Nome | Obrigatório | Tipo | Descrição |
| - | - | - | - |
| Authorization | TRUE | integer | O chamador deve fornecer um XToken no formato de autorização XBL 3.0. Por exemplo, Authorization: XBL3.0 x=2553948354698;>encrypted token \<) |
| Content-Type | TRUE | string | ContentType deve ser definido como application/json |

<a id="responses" />

## Respostas

| Nome | Tipo | Descrição |
| - | - | - |
| 200 OK | [GetActivityBatchResponse](#getactivitybatchresponse) | O objeto retornado contém uma lista de atividades para cada usuário. Se o usuário não tiver uma atividade atual, a lista de atividades desse usuário estará vazia. Se houver um problema no serviço ao obter as atividades de um usuário, a lista de atividades desse usuário será null. |
| 400 Bad Request | [ErrorResponse](#errorresponse) | Ocorreu um erro ao processar a solicitação. Códigos de erro possíveis: "InvalidRequest - The request payload is invalid.", " AuthorizationError: The caller is not allowed to access the resource." |
| Outros códigos de status | [ThrottledEntity](#throttledentity) | Excesso de solicitações. Cabeçalhos Retry-After: integer |

<a id="definitions" />

## Definições

* [ErrorResponse](#errorresponse)
* [GetActivityBatchRequest](#getactivitybatchrequest)
* [GetActivityBatchResponse](#getactivitybatchresponse)
* [GetActivityResponse](#getactivityresponse)
* [JoinRestriction](#joinrestriction)
* [Platform](#platform)
* [ThrottledEntity](#throttledentity)
* [UserActivity](#useractivity)

<a id="errorresponse" />

### ErrorResponse

| Nome | Tipo | Descrição |
| - | - | - |
| debugMessage | string | Versão legível da mensagem de erro que pode ser usada para depuração. |
| errorCode | string | Enumeração do código de erro. |

<a id="getactivitybatchrequest" />

### GetActivityBatchRequest

| Nome | Tipo | Descrição |
| - | - | - |
| users | string\[] | As IDs dos usuários cujas informações de atividade precisam ser recuperadas. Há suporte para até 30 usuários. |

<a id="getactivitybatchresponse" />

### GetActivityBatchResponse

| Nome | Tipo | Descrição |
| - | - | - |
| userActivities | [UserActivity](#useractivity)\[] | |

<a id="getactivityresponse" />

### GetActivityResponse

| Nome | Tipo | Descrição |
| - | - | - |
| connectionString | string | A cadeia de conexão é o objeto passado ao cliente que está se conectando para que ele ingresse no jogo. A cadeia de conexão geralmente contém informações como o IP do servidor para permitir que o usuário que está ingressando se conecte. O comprimento da cadeia de conexão é limitado a 512 caracteres. |
| currentPlayers | integer | O número de jogadores que já estão jogando com o usuário em uma atividade multijogador. |
| groupId | string | Um identificador exclusivo para agrupar todos os usuários que estão jogando como parte do mesmo jogo. |
| joinRestriction | [JoinRestriction](#joinrestriction) | A configuração que define quem pode ingressar com o jogador atual. |
| maxPlayers | integer | O número máximo de jogadores que podem jogar com esse jogador na atividade atual. |
| platform | [Platform](#platform) | |
| sequenceNumber | string | Esta é uma representação em cadeia de caracteres de um número monotonicamente crescente (ulong) que o cliente deve passar em cada solicitação. Ele é usado para garantir a ordem das atualizações de uma atividade. Um bom exemplo de sequenceNumber é o horário unix do cliente, pois ele é garantidamente crescente. Deve ser maior que 0 e não pode ser maior que o ulong máximo. |
| titleId | integer | O titleId do jogo para o qual a atividade foi solicitada. |

<a id="joinrestriction" />

### JoinRestriction

| Nome | Tipo | Descrição |
| - | - | - |
| Followed | string | |
| InviteOnly | string | |
| Public | string | |

<a id="platform" />

### Platform

| Nome | Tipo | Descrição |
| - | - | - |
| Android | string | |
| IOS | string | |
| Nintendo | string | |
| PlayStation | string | |
| Scarlett | string | |
| Win32 | string | |
| WindowsOneCore | string | |
| XboxOne | string | |

<a id="throttledentity" />

### ThrottledEntity

| Nome | Tipo | Descrição |
| - | - | - |
| currentRequests | string | Número atual de solicitações: simultaneidade ou taxa. |
| debugMessage | string | Versão legível da mensagem de limitação que pode ser usada para depuração. |
| limitType | string | O tipo de limite, ou seja, simultaneidade ou taxa. |
| maxRequests | string | Máximo de solicitações permitidas: simultaneidade ou taxa. |
| periodInSeconds | string | O período, em segundos, que se aplica quando os limites de taxa ou simultaneidade são excedidos. |
| version | string | Versão atual do contrato de limitação. |

<a id="useractivity" />

### UserActivity

| Nome | Tipo | Descrição |
| - | - | - |
| activities | [GetActivityResponse](#getactivityresponse)\[] | |
| userId | string | |


## Related topics

- [Requisitos XBOX testados na certificação para jogos de console XBOX](/pt-BR/publishing/certification/console-cert-tested-requirements.md)
- [Lotes](/es/publishing/game-publishing/concepts/bundle.md)
- [XR-064 Sessões de jogo com entrada permitida e jogo online](/pt-BR/publishing/certification/xr/xr-064.md)
- [Casos de teste com mais falhas](/pt-BR/publishing/certification/xr-top-failing.md)
- [XR-057 Desbloqueio de conquistas](/pt-BR/publishing/certification/xr/xr-057.md)
