Skip to main content

​
POST (/handles/query?include=relatedInfo)

Crée des requêtes de descripteurs de session qui incluent des informations de session connexes.
Important :
Cette méthode est utilisée par le multijoueur 2015 et s’applique uniquement à cette version multijoueur et aux versions ultérieures. Elle est destinée à être utilisée avec le contrat de modèle 104/105 ou ultérieur et nécessite un élément d’en-tête X-Xbl-Contract-Version: 104/105 ou ultérieur dans chaque requête.

​
Remarques

Cette méthode HTTP/REST crée des requêtes de données de descripteur avec les informations de session spécifiées dans la chaîne de requête « include ». La valeur de la chaîne de requête est conçue pour être extensible afin de prendre en charge de futures options de requête, et accepte une liste délimitée par des virgules, par exemple « ?include=relatedInfo,session ». La méthode POST peut être encapsulée par Microsoft.Xbox.Services.Multiplayer.MultiplayerService.GetActivitiesForUsersAsync. Le champ type du corps de la requête de cette méthode doit être défini sur « activity ». Les éléments du corps de la réponse correspondent directement aux propriétés de Microsoft.Xbox.Services.Multiplayer.MultiplayerActivityDetails.

​
Paramètres d’URI

​
Paramètres de chaîne de requête

Une requête peut être modifiée au moyen des paramètres de chaîne de requête du tableau suivant. | Paramètre| Type| Description| | --- | --- | --- | --- | | keyword| chaîne| Un mot clé, par exemple « foo », qui doit se trouver dans les sessions ou les modèles pour que ceux-ci soient récupérés. | | xuid| entier non signé 64 bits| L’ID d’utilisateur XBOX, par exemple « 123 », des sessions à inclure dans la requête. Par défaut, l’utilisateur doit être actif dans la session pour que celle-ci soit incluse. | | reservations| booléen| True pour inclure les sessions pour lesquelles l’utilisateur est défini comme joueur réservé, mais ne s’est pas joint pour devenir un joueur actif. Ce paramètre est utilisé uniquement lors de l’interrogation de vos propres sessions, ou lors de l’interrogation de serveur à serveur des sessions d’un utilisateur précis. | | inactive| booléen| True pour inclure les sessions que l’utilisateur a acceptées, mais auxquelles il ne joue pas activement. Les sessions dans lesquelles l’utilisateur est « ready » (prêt), mais pas « active » (actif), sont considérées comme inactives. | | private| booléen| True pour inclure les sessions privées. Ce paramètre est utilisé uniquement lors de l’interrogation de vos propres sessions, ou lors de l’interrogation de serveur à serveur des sessions d’un utilisateur précis. | | visibility| chaîne| État de visibilité des sessions. Les valeurs possibles sont définies par Microsoft.Xbox.Services.Multiplayer.MultiplayerSessionVisibility. Si ce paramètre est défini sur « open », la requête doit inclure uniquement les sessions ouvertes. S’il est défini sur « private », le paramètre private doit être défini sur true. | | version| entier signé 32 bits| La version de session maximale à inclure. Par exemple, une valeur de 2 indique que seules les sessions dont la version de session principale est 2 ou moins doivent être incluses. Le numéro de version doit être inférieur ou égal à la version de contrat de la requête modulo 100. | | take| entier signé 32 bits| Le nombre maximal de sessions à récupérer. Ce nombre doit être compris entre 0 et 100. | Définir private ou reservations sur true nécessite un accès de niveau serveur à la session. Sinon, ces paramètres exigent que la revendication XUID de l’appelant corresponde au filtre XUID de l’URI. Dans le cas contraire, le code d’état HTTP/403 est retourné, que de telles sessions existent ou non.

​
Codes d’état HTTP

Le service retourne un code d’état HTTP tel qu’il s’applique au MPSD.

​
Corps de la requête

​
Exemple de requête

Pour obtenir toutes les activités du graphe social « favorites » (favoris) d’un utilisateur, le corps POST se présente comme suit :

​
Corps de la réponse

Les résultats sont retournés sous forme de tableau de structures de descripteur, avec un ID unique incorporé dans chaque descripteur. Les informations de session précises sont retournées dans l’objet relatedInfo. Notez que ces informations ne sont pas retournées par la méthode POST ordinaire sur cet URI.

​
Exemple de réponse

​
Voir aussi

Parent
/handles/query
Last modified on October 19, 2026