Obtenir l’activité
Obtient l’activité d’un utilisateur qui joue à un titre spécifique. Cette API permet à un client ou à un serveur de jeu d’obtenir l’activité d’un utilisateur qui joue à un titre particulier.GET /titles/{titleId}/users/{xuid}/activities
Paramètres d’URI
| Paramètre | Emplacement | Obligatoire | Type | Description |
|---|---|---|---|---|
| titleId | path | TRUE | integer | titleId du jeu pour lequel la requête est envoyée. |
| xuid | path | TRUE | string | XUID de l’utilisateur concerné par la requête actuelle. Le XUID est représenté sous forme d’entier en base 10. |
En-tête de requête
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| Authorization | TRUE | integer | L’appelant doit fournir un XToken au format d’autorisation XBL 3.0. Par exemple, Authorization: XBL3.0 x=2553948354698;>jeton chiffré<) |
| Content-Type | TRUE | string | ContentType doit être défini sur application/json |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK | GetActivityResponse | Objet renvoyé contenant l’activité de l’utilisateur donné. |
| 204 No Content | La requête a réussi, mais aucune activité n’a été trouvée à renvoyer. | |
| 400 Bad Request | ErrorResponse | Une erreur s’est produite lors du traitement de la requête. Codes d’erreur possibles : “RequestValidationError: La validation de la requête a échoué.”, ” AuthorizationError: L’appelant n’est pas autorisé à accéder à la ressource. Trop de requêtes.” |
| Autres codes d’état | ThrottledEntity | Trop de requêtes. En-têtes Retry-After: integer |
Définitions
ErrorResponse
| Nom | Type | Description |
|---|---|---|
| debugMessage | string | Version lisible du message d’erreur, utilisable pour le débogage. |
| errorCode | string | Énumération du code d’erreur. |
GetActivityResponse
| Nom | Type | Description |
|---|---|---|
| connectionString | string | La chaîne de connexion est l’objet transmis au client qui se connecte afin de rejoindre la partie. Elle contient généralement des informations telles que l’adresse IP du serveur pour permettre à l’utilisateur qui rejoint de se connecter. La longueur de la chaîne de connexion est limitée à 512 caractères. |
| currentPlayers | integer | Nombre de joueurs qui jouent déjà avec l’utilisateur dans une activité multijoueur. |
| groupId | string | Identificateur unique permettant de regrouper tous les utilisateurs qui jouent dans la même partie. |
| joinRestriction | JoinRestriction | Paramètre qui détermine qui peut rejoindre le joueur actuel. |
| maxPlayers | integer | Nombre maximal de joueurs pouvant jouer avec ce joueur dans l’activité actuelle. |
| platform | Platform | |
| sequenceNumber | string | Représentation sous forme de chaîne d’un nombre monotone croissant (ulong) que le client doit transmettre à chaque requête. Il permet de garantir l’ordre des mises à jour d’une activité. Un bon exemple de sequenceNumber est l’heure Unix du client, car elle est garantie croissante. Doit être supérieur à 0 et ne peut pas dépasser la valeur ulong maximale. |
| titleId | integer | titleId du jeu pour lequel l’activité a été demandée. |
JoinRestriction
| Nom | Type | Description |
|---|---|---|
| Followed | string | |
| InviteOnly | string | |
| Public | string |
Platform
| Nom | Type | Description |
|---|---|---|
| Android | string | |
| IOS | string | |
| Nintendo | string | |
| PlayStation | string |
ThrottledEntity
| Nom | Type | Description |
|---|---|---|
| currentRequests | string | Nombre actuel de requêtes (simultanéité ou débit). |
| debugMessage | string | Version lisible du message de limitation, utilisable pour le débogage. |
| limitType | string | Type de limite, c’est-à-dire simultanéité ou débit. |
| maxRequests | string | Nombre maximal de requêtes autorisées (simultanéité ou débit). |
| periodInSeconds | string | Période en secondes qui s’applique en cas de dépassement des limites de débit ou de simultanéité. |
| version | string | Version actuelle du contrat de limitation. |