Obtener actividad
Obtiene la actividad de un usuario que juega a un título específico. Esta API permite que un cliente o servidor de juego obtenga la actividad de un usuario que juega a un título determinado.GET /titles/{titleId}/users/{xuid}/activities
Parámetros de URI
| Parámetro | En | Obligatorio | Tipo | Descripción |
|---|---|---|---|---|
| titleId | path | TRUE | integer | El titleId del juego para el que se envía la solicitud. |
| xuid | path | TRUE | string | El XUID del usuario al que se hace referencia en la solicitud actual. El XUID se representa como un entero en base 10. |
Encabezado de la solicitud
| Nombre | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| Authorization | TRUE | integer | El autor de la llamada debe proporcionar un XToken en el formato de autorización XBL 3.0. Por ejemplo, Authorization: XBL3.0 x=2553948354698;>encrypted token<) |
| Content-Type | TRUE | string | ContentType debe establecerse en application/json |
Respuestas
| Nombre | Tipo | Descripción |
|---|---|---|
| 200 OK | GetActivityResponse | Un objeto devuelto con la actividad del usuario especificado. |
| 204 No Content | La solicitud se realizó correctamente, pero no se encontró ninguna actividad que devolver. | |
| 400 Bad Request | ErrorResponse | Se produjo un error al procesar la solicitud. Códigos de error posibles: “RequestValidationError: The request validation has failed.”, ” AuthorizationError: The caller is not allowed to access the resource. Too many requests.” |
| Otros códigos de estado | ThrottledEntity | Demasiadas solicitudes. Encabezados Retry-After: integer |
Definiciones
ErrorResponse
| Nombre | Tipo | Descripción |
|---|---|---|
| debugMessage | string | Versión legible del mensaje de error que se puede usar para depurar. |
| errorCode | string | Enumeración de códigos de error. |
GetActivityResponse
| Nombre | Tipo | Descripción |
|---|---|---|
| connectionString | string | La cadena de conexión es el objeto que se pasa al cliente que se conecta para poder unirse al juego. La cadena de conexión suele contener información como la IP del servidor para permitir que el usuario que se une pueda conectarse. La longitud de la cadena de conexión está limitada a 512 caracteres. |
| currentPlayers | integer | El número de jugadores que ya están jugando con el usuario en una actividad multijugador. |
| groupId | string | Un identificador único para agrupar a todos los usuarios que juegan como parte del mismo juego. |
| joinRestriction | JoinRestriction | La configuración que determina quién puede unirse al jugador actual. |
| maxPlayers | integer | El número máximo de jugadores que pueden jugar con este jugador en la actividad actual. |
| platform | Platform | |
| sequenceNumber | string | Es una representación de cadena de un número monótonamente creciente (ulong) que el cliente debe pasar en cada solicitud. Se usa para garantizar el orden de las actualizaciones de una actividad. Un buen ejemplo de sequenceNumber puede ser la hora Unix del cliente, ya que se garantiza que va en aumento. Debe ser mayor que 0 y no puede ser mayor que el valor máximo de ulong. |
| titleId | integer | El titleId del juego para el que se solicitó la actividad. |
JoinRestriction
| Nombre | Tipo | Descripción |
|---|---|---|
| Followed | string | |
| InviteOnly | string | |
| Public | string |
Platform
| Nombre | Tipo | Descripción |
|---|---|---|
| Android | string | |
| IOS | string | |
| Nintendo | string | |
| PlayStation | string |
ThrottledEntity
| Nombre | Tipo | Descripción |
|---|---|---|
| currentRequests | string | Número actual de solicitudes: simultaneidad o frecuencia. |
| debugMessage | string | Versión legible del mensaje de limitación que se puede usar para depurar. |
| limitType | string | El tipo de límite, es decir, simultaneidad o frecuencia. |
| maxRequests | string | Número máximo de solicitudes permitidas: simultaneidad o frecuencia. |
| periodInSeconds | string | El período en segundos que se aplica cuando se superan los límites de frecuencia o simultaneidad. |
| version | string | Versión actual del contrato de limitación. |