Obtenir une 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 | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
| titleId | chemin | TRUE | entier | Le titleId du jeu pour lequel la requête est envoyée. |
| xuid | chemin | TRUE | chaîne | Le XUID de l’utilisateur auquel la requête actuelle fait référence. Le XUID est représenté sous forme d’entier en base 10. |
En-tête de la requête
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| Authorization | TRUE | entier | 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 | chaîne | ContentType doit être défini sur application/json |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK | GetActivityResponse | Un objet retourné contenant l’activité de l’utilisateur donné. |
| 204 No Content | La requête a réussi, mais aucune activité à retourner n’a été trouvée. | |
| 400 Bad Request | ErrorResponse | Une erreur s’est produite lors du traitement de la requête. Codes d’erreur possibles : “RequestValidationError: The request validation has failed.”, ” AuthorizationError: The caller is not allowed to access the resource. Too many requests.” |
| Autres codes d’état | ThrottledEntity | Trop de requêtes. En-têtes Retry-After: integer |
Définitions
ErrorResponse
| Nom | Type | Description |
|---|---|---|
| debugMessage | chaîne | Version lisible du message d’erreur pouvant être utilisée pour le débogage. |
| errorCode | chaîne | Énumération du code d’erreur. |
GetActivityResponse
| Nom | Type | Description |
|---|---|---|
| connectionString | chaîne | La chaîne de connexion est l’objet passé au client qui se connecte afin de rejoindre la partie. La chaîne de connexion contient généralement des informations comme l’adresse IP du serveur pour permettre à l’utilisateur qui se joint de se connecter. La longueur de la chaîne de connexion est limitée à 512 caractères. |
| currentPlayers | entier | Le nombre de joueurs qui jouent déjà avec l’utilisateur dans une activité multijoueur. |
| groupId | chaîne | Un identificateur unique permettant de regrouper tous les utilisateurs qui jouent dans la même partie. |
| joinRestriction | JoinRestriction | Le paramètre qui détermine qui peut rejoindre le joueur actuel. |
| maxPlayers | entier | Le nombre maximal de joueurs pouvant jouer avec ce joueur dans l’activité en cours. |
| platform | Platform | |
| sequenceNumber | chaîne | Il s’agit d’une représentation sous forme de chaîne d’un nombre à croissance monotone (ulong) que le client doit passer pour chaque requête. Il sert à garantir l’ordre des mises à jour d’une activité. Un bon exemple de sequenceNumber est l’heure Unix du client, puisqu’elle est garantie d’être croissante. Doit être supérieur à 0 et ne peut pas être supérieur à la valeur maximale d’un ulong. |
| titleId | entier | Le titleId du jeu pour lequel l’activité a été demandée. |
JoinRestriction
| Nom | Type | Description |
|---|---|---|
| Followed | chaîne | |
| InviteOnly | chaîne | |
| Public | chaîne |
Platform
| Nom | Type | Description |
|---|---|---|
| Android | chaîne | |
| IOS | chaîne | |
| Nintendo | chaîne | |
| PlayStation | chaîne |
ThrottledEntity
| Nom | Type | Description |
|---|---|---|
| currentRequests | chaîne | Nombre actuel de requêtes - simultanéité ou débit. |
| debugMessage | chaîne | Version lisible du message de limitation pouvant être utilisée pour le débogage. |
| limitType | chaîne | Le type de limite, c’est-à-dire simultanéité ou débit. |
| maxRequests | chaîne | Nombre maximal de requêtes autorisées - simultanéité ou débit. |
| periodInSeconds | chaîne | La période en secondes qui s’applique lorsque les limites de débit ou de simultanéité sont dépassées. |
| version | chaîne | Version actuelle du contrat de limitation. |