Skip to main content

POST (/handles/query?include=relatedInfo)

Crée des requêtes sur les handles de session qui incluent des informations de session associées.
Important :
Cette méthode est utilisée par le multijoueur 2015 et s’applique uniquement à cette version du 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 sur chaque requête.

Remarques

Cette méthode HTTP/REST crée des requêtes sur les données de handle 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 pour 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 à l’aide des paramètres de chaîne de requête du tableau suivant. | Paramètre| Type| Description| | --- | --- | --- | --- | | keyword| string| Mot clé, par exemple “foo”, qui doit figurer dans les sessions ou les modèles pour qu’ils soient récupérés. | | xuid| entier non signé 64 bits| ID 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| boolean| True pour inclure les sessions dans lesquelles l’utilisateur est défini comme joueur réservé mais n’a pas rejoint la session 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 spécifique. | | inactive| boolean| 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” mais pas “active” sont considérées comme inactives. | | private| boolean| 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 spécifique. | | visibility| string| É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| Version de session maximale à inclure. Par exemple, une valeur de 2 indique que seules les sessions dont la version de session principale est inférieure ou égale à 2 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| 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 applicable au MPSD.

Corps de la requête

Exemple de requête

Pour obtenir toutes les activités du graphe social “favorites” d’un utilisateur, le corps de la requête POST se présente comme suit :

Corps de la réponse

Les résultats sont retournés sous la forme d’un tableau de structures de handle, avec un ID unique incorporé dans chaque handle. Les informations de session spécifiques sont retournées dans l’objet relatedInfo. Notez que ces informations ne sont pas retournées pour la méthode POST standard sur cet URI.

Exemple de réponse

Voir aussi

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