GET (/users/xuid()/groups/ )

Obtient le PresenceRecord d’un groupe. Le domaine de ces URI est userpresence.xboxlive.com.

Remarques
Paramètres d’URI
Paramètres de chaîne de requête
Autorisation
Effet des paramètres de confidentialité sur la ressource
En-têtes de requête obligatoires
En-têtes de requête facultatifs
Corps de la requête
Codes d’état HTTP
En-têtes de réponse obligatoires
En-têtes de réponse facultatifs
Corps de la réponse

Remarques

Récupère les utilisateurs du groupe spécifié par le moniker associé à l’utilisateur figurant dans l’URI, et retourne le PresenceRecord de ces utilisateurs. Les données soumises aux règles de confidentialité ou d’isolation du contenu ne sont tout simplement pas retournées.

Paramètres d’URI

Paramètre	Type	Description
xuid	chaîne	ID utilisateur XBOX (XUID) de l’utilisateur associé aux XUID du groupe.
moniker	chaîne	Chaîne définissant le groupe d’utilisateurs. Le seul moniker accepté actuellement est “People” avec un ‘P’ majuscule.

Paramètres de chaîne de requête

| Paramètre| Type| Description| | --- | --- | --- | --- | --- | --- | | level| chaîne| Retourne le niveau de détail spécifié par cette chaîne de requête. Les options valides sont “user”, “device”, “title” et “all”. Le niveau “user” correspond à l’objet PresenceRecord sans l’objet imbriqué DeviceRecord. Le niveau “device” correspond aux objets PresenceRecord et DeviceRecord sans l’objet imbriqué TitleRecord. Le niveau “title” correspond aux objets PresenceRecord, DeviceRecord et TitleRecord sans l’objet imbriqué ActivityRecord. Le niveau “all” correspond à l’enregistrement entier, y compris tous les objets imbriqués. Si ce paramètre n’est pas fourni, le service utilise par défaut le niveau title (c’est-à-dire qu’il retourne la présence de cet utilisateur jusqu’aux détails du titre).|

Autorisation

Revendications d’autorisation utilisées | Revendication| Type| Obligatoire ?| Exemple de valeur| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Xuid| entier signé 64 bits| oui| 1234567890|

Effet des paramètres de confidentialité sur la ressource

Le service retourne toujours 200 OK si la requête elle-même est correctement formée. Toutefois, il filtre les informations de la réponse lorsque les vérifications de confidentialité échouent. Effet des paramètres de confidentialité sur la ressource | Utilisateur demandeur| Paramètre de confidentialité de l’utilisateur cible| Comportement| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | moi| -| Comme décrit.| | ami| tout le monde| Comme décrit.| | ami| amis uniquement| Comme décrit.| | ami| bloqué| Comme décrit : le service filtre les données.| | utilisateur non ami| tout le monde| Comme décrit.| | utilisateur non ami| amis uniquement| Comme décrit : le service filtre les données.| | utilisateur non ami| bloqué| Comme décrit : le service filtre les données.| | site tiers| tout le monde| Comme décrit : le service filtre les données.| | site tiers| amis uniquement| Comme décrit : le service filtre les données.| | site tiers| bloqué| Comme décrit : le service filtre les données.|

En-têtes de requête obligatoires

| En-tête| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| chaîne| Informations d’identification d’authentification pour l’authentification HTTP. Exemple de valeur : “XBL3.0 x=<userhash>;<token>”.| | x-xbl-contract-version| chaîne| Nom/numéro de build du service XBOX LIVE vers lequel cette requête doit être dirigée. La requête n’est routée vers ce service qu’après vérification de la validité de l’en-tête, des revendications du jeton d’authentification, etc. Exemples de valeurs : 3, vnext.| | Accept| chaîne| Types de contenu acceptables. Le seul pris en charge par Presence est application/json, mais il doit tout de même être spécifié dans l’en-tête.| | Accept-Language| chaîne| Paramètres régionaux acceptables pour les chaînes de la réponse. Exemple de valeur : en-US.| | Host| chaîne| Nom de domaine du serveur. Exemple de valeur : userpresence.xboxlive.com.|

En-têtes de requête facultatifs

| En-tête| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | X-RequestedServiceVersion| | Nom/numéro de build du service XBOX LIVE vers lequel cette requête doit être dirigée. La requête n’est routée vers ce service qu’après vérification de la validité de l’en-tête, des revendications du jeton d’authentification, etc. Valeur par défaut : 1.|

Corps de la requête

Aucun objet n’est envoyé dans le corps de cette requête.

Codes d’état HTTP

Le service retourne l’un des codes d’état de cette section en réponse à une requête effectuée avec cette méthode sur cette ressource. Pour obtenir la liste complète des codes d’état HTTP standard utilisés avec les services XBOX Live, consultez Codes d’état HTTP standard. | Code| Expression de raison| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 200| OK| La session a été récupérée avec succès.| | 400| Bad Request| Le service n’a pas pu comprendre la requête mal formée. Généralement un paramètre non valide.| | 401| Unauthorized| La requête nécessite l’authentification de l’utilisateur.| | 403| Forbidden| La requête n’est pas autorisée pour l’utilisateur ou le service.| | 404| Not Found| La ressource spécifiée est introuvable.| | 405| Method Not Allowed| La méthode HTTP a été utilisée sur un type de contenu non pris en charge.| | 406| Not Acceptable| La version de la ressource n’est pas prise en charge.| | 500| Request Timeout| Le service n’a pas pu comprendre la requête mal formée. Généralement un paramètre non valide.| | 503| Request Timeout| Le service n’a pas pu comprendre la requête mal formée. Généralement un paramètre non valide.|

En-têtes de réponse obligatoires

| En-tête| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | x-xbl-contract-version| chaîne| Nom/numéro de build du service XBOX LIVE vers lequel cette requête doit être dirigée. La requête n’est routée vers ce service qu’après vérification de la validité de l’en-tête, des revendications du jeton d’authentification, etc. Exemples de valeurs : 1, vnext.| | Content-Type| chaîne| Type MIME du corps de la requête. Exemple de valeur : application/json.| | Cache-Control| chaîne| Demande polie pour spécifier le comportement de mise en cache. Exemples de valeurs : “no-cache”.| | X-XblCorrelationId| chaîne| Valeur générée par le service pour mettre en corrélation ce que le serveur retourne et ce que le client reçoit. Exemple de valeur : “4106d0bc-1cb3-47bd-83fd-57d041c6febe”.| | X-Content-Type-Option| chaîne| Retourne la valeur conforme au SDL. Exemple de valeur : “nosniff”.| | Date| chaîne| Date/heure d’envoi du message. Exemple de valeur : “Tue, 17 Nov 2012 10:33:31 GMT”.|

En-têtes de réponse facultatifs

| En-tête| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Retry-After| chaîne| Retourné en cas d’erreurs HTTP 503. Indique au client combien de temps attendre avant de réessayer l’appel. Exemples de valeurs : “120”.| | Content-Length| chaîne| Longueur du corps de la réponse. Exemple de valeur : “527”.| | Content-Encoding| chaîne| Type d’encodage de la réponse. Exemple de valeur : “gzip”.|

Corps de la réponse

Cette API retourne un tableau d’objets PresenceRecord, un pour chacun des XUID de la requête.

Exemple de réponse

[
     {
         xuid:"0123456789",
         state:"online",
         devices:
         [
             {
                 type:"D",
                 titles:
                 [
                     {
                         id:"12341234",
                         name:"Contoso 5",
                         lastModified:"2012-09-17T07:15:23.4930000",
                         placement:"full",
                         state:"active",
                         activity:
                         {
                             richPresence:"Playing on Nirvana"
                         },
                     }
                 ]
             }
         ]
     },
     {
         xuid:"0123456780",
         state:"online",
         devices:
         [
             {
                 type:"D",
                 titles:
                 [
                     {
                         id:"12341235",
                         name:"Contoso Waypoint",
                         lastModified:"2012-09-17T07:15:23.4930000",
                         placement;"full",
                         state:"active",
                         activity:
                         {
                             richPresence:"Viewing stats"
                         },
                     }
                 ]
             }
         ]
     },
     {
         xuid:"0123456781",
         state:"online",
         devices:
         [
             {
                 type:"Win8",
                 titles:
                 [
                     {
                         id:"23452345",
                         name:"Contoso Gamehelp",
                         state:"active",
                         timestamp:"2012-09-17T07:15:23.4930000",
                         activity:
                         {
                             richPresence:"Viewing help"
                         }
                     }
                 ]
             }
         ]
     }
 ]
         

Voir aussi

Parent

/users/xuid()/groups/

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

GET (/users/xuid({xuid})/groups/{moniker} )

GET (/users/xuid()/groups/ )

Remarques

Paramètres d’URI

Paramètres de chaîne de requête

Autorisation

Effet des paramètres de confidentialité sur la ressource

En-têtes de requête obligatoires

En-têtes de requête facultatifs

Corps de la requête

Codes d’état HTTP

En-têtes de réponse obligatoires

En-têtes de réponse facultatifs

Corps de la réponse

Exemple de réponse

Voir aussi

Parent

​GET (/users/xuid()/groups/ )

​Remarques

​Paramètres d’URI

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

​Autorisation

​Effet des paramètres de confidentialité sur la ressource

​En-têtes de requête obligatoires

​En-têtes de requête facultatifs

​Corps de la requête

​Codes d’état HTTP

​En-têtes de réponse obligatoires

​En-têtes de réponse facultatifs

​Corps de la réponse

​Exemple de réponse

​Voir aussi

Parent

GET (/users/xuid()/groups/ )

Remarques

Paramètres d’URI

Paramètres de chaîne de requête

Autorisation

Effet des paramètres de confidentialité sur la ressource

En-têtes de requête obligatoires

En-têtes de requête facultatifs

Corps de la requête

Codes d’état HTTP

En-têtes de réponse obligatoires

En-têtes de réponse facultatifs

Corps de la réponse

Exemple de réponse

Voir aussi