> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET (/users/xuid({xuid})/scids/{scid}/stats/{statname)/people/{all|favorite})

> GET (/users/xuid(\{xuid})/scids/\{scid}/stats/\{statname)/people/\{all|favorite})

# GET (/users/xuid(\{xuid})/scids/\{scid}/stats/\{statname)/people/\{all|favorite})

Retourne un classement social en classant les valeurs de statistiques (scores) soit de tous les contacts connus de l'utilisateur actuel, soit uniquement des contacts désignés comme personnes favorites par cet utilisateur.
Le domaine de ces URI est `leaderboards.xboxlive.com`.

* [Remarques](#ID4EV)
* [Paramètres d'URI](#ID4EAB)
* [Paramètres de chaîne de requête](#ID4ELB)
* [Autorisation](#ID4EQD)
* [En-têtes de requête obligatoires](#ID4EGE)
* [En-têtes de requête facultatifs](#ID4EXF)
* [Corps de la requête](#ID4ETG)
* [Codes d'état HTTP](#ID4ECEAC)
* [En-têtes de réponse obligatoires](#ID4E1HAC)
* [En-têtes de réponse facultatifs](#ID4EDJAC)
* [Corps de la réponse](#ID4EDKAC)

## Remarques

Les API de classement sont toutes en lecture seule et ne prennent donc en charge que le verbe GET (via HTTPS). Elles reflètent des "pages" classées et triées de statistiques de joueur indexées, dérivées de statistiques utilisateur individuelles écrites via le système Player Data. Les index de classement complets peuvent être très volumineux, et les appelants ne demanderont jamais à en voir un dans son intégralité ; cet URI prend donc en charge plusieurs arguments de chaîne de requête qui permettent à un appelant de préciser le type de vue qu'il souhaite obtenir sur ce classement.

Les opérations GET ne modifient aucune ressource ; elles produisent donc les mêmes résultats qu'elles soient exécutées une ou plusieurs fois.

## Paramètres d'URI

| Paramètre | Type | Description |
| - | - | - |
| xuid | string | Identificateur de l'utilisateur. |
| scid | string | Identificateur de la configuration de service qui contient la ressource consultée. |
| statname | string | Identificateur unique de la ressource de statistique utilisateur consultée. |
| all ou favorite | énumération | Indique s'il faut classer les valeurs de statistiques (scores) de tous les contacts connus de l'utilisateur actuel ou uniquement des contacts désignés comme personnes favorites par cet utilisateur. |

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

| Paramètre | Type | Description |
| - | - | - |
| maxItems | entier non signé 32 bits | Nombre maximal d'enregistrements de classement à retourner dans une page de résultats. S'il n'est pas spécifié, un nombre par défaut est retourné (10). La valeur maximale de maxItems n'est pas encore définie, mais nous souhaitons éviter les jeux de données volumineux ; cette valeur doit donc probablement cibler le plus grand ensemble qu'une interface utilisateur de tuner peut gérer par appel. |
| skipToRank | entier non signé 32 bits | Retourne une page de résultats commençant au rang de classement spécifié. Les autres résultats sont triés par rang. Cette chaîne de requête peut retourner un jeton de continuation qui peut être réinjecté dans une requête ultérieure pour obtenir "la page suivante" de résultats. |
| skipToUser | string | Retourne une page de résultats de classement autour du xuid du joueur spécifié, quel que soit le rang ou le score de cet utilisateur. La page est triée par rang centile, l'utilisateur spécifié étant en dernière position de la page pour les vues prédéfinies, ou au milieu pour les vues de classement de statistiques. Aucun **continuationToken** n'est fourni pour ce type de requête. |
| continuationToken | string | Si un appel précédent a retourné un **continuationToken**, l'appelant peut renvoyer ce jeton "tel quel" dans une chaîne de requête pour obtenir la page de résultats suivante. |
| sort | string | Indique s'il faut classer la liste des joueurs par ordre de valeur croissant ("ascending") ou décroissant ("descending"). Ce paramètre est facultatif ; la valeur par défaut est l'ordre décroissant. |

## Autorisation

Une autorisation par xuid est requise.

Une logique d'autorisation est implémentée pour les scénarios d'isolation du contenu et de contrôle d'accès.

Les classements et les statistiques utilisateur peuvent être lus à partir de clients sur n'importe quelle plateforme, à condition que l'appelant soumette un jeton XSTS valide avec la requête. Les écritures sont évidemment limitées aux clients pris en charge par le système Player Data.

Les développeurs de titres peuvent marquer les statistiques comme ouvertes ou restreintes avec Partner Center. Les classements sont des statistiques ouvertes. Les statistiques ouvertes sont accessibles par Smartglass, ainsi que par les applications iOS, Android, Windows, Windows Phone et web, à condition que l'utilisateur soit autorisé à accéder au bac à sable. L'autorisation d'un utilisateur pour un bac à sable est gérée via Partner Center.

## En-têtes de requête obligatoires

| En-tête | Description |
| - | - |
| Authorization | String. Informations d'identification pour l'authentification HTTP. Exemple de valeur : "XBL3.0 x=\<userhash>;\<token>". |
| Content-Type | String. Type MIME du corps de la requête. Exemple de valeur : "application/json". |
| 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 acheminé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. |
| Accept | String. Valeurs Content-Type acceptables. Exemple de valeur : "application/json". |

## En-têtes de requête facultatifs

| En-tête | Description |
| - | - |
| If-None-Match | String. Balise d'entité, utilisée si le client prend en charge la mise en cache. Exemple de valeur : "686897696a7c876b7e". |

## Corps de la requête

Pour que tout appelant puisse comprendre au mieux les données qu'il reçoit afin de les afficher correctement, chaque valeur de statistique de chaque utilisateur est retournée sous forme de chaîne dans le format dans lequel elle doit être affichée, et mise en forme selon les paramètres régionaux spécifiés dans l'en-tête accept-language de la requête. Un "nom d'affichage" localisé est également retourné pour le statname de ce classement.

### Membres obligatoires

| Membre | Type | Description |
| - | - | - |
| **pagingInfo** | section | Facultatif. Retourné lorsque le rang de la dernière entrée de la page est inférieur à totalItems. Cette section n'est pas non plus retournée lorsque skipToUser est spécifié dans la requête. |
| continuationToken | string | Obligatoire. Spécifie la valeur à réinjecter dans le paramètre de requête "continuationToken" pour obtenir la page de résultats suivante pour cet URI, si nécessaire. Si aucun pagingInfo n'est retourné, il n'y a pas de "page suivante" de données à obtenir. |
| totalItems | entier non signé 64 bits | Obligatoire. Nombre total d'entrées dans le classement. |
| **leaderboardInfo** | section | Obligatoire. Toujours retourné. Contient les métadonnées du classement demandé. |
| displayName | string | Obligatoire. Nom d'affichage localisé du classement prédéfini. Exemple de valeur : "Total flags captured". |
| totalCount | string | Obligatoire. Nombre total d'entrées dans le classement. |
| columns | array | Obligatoire. |
| displayName | string | Obligatoire. Correspond à une colonne du classement. |
| statName | string | Obligatoire. Correspond à une colonne du classement. |
| type | string | Obligatoire. Correspond à une colonne du classement. |
| **userList** | section | Obligatoire. Toujours retourné. Contient les scores réels des utilisateurs pour le classement demandé. |
| gamertag | string | Obligatoire. Correspond à l'utilisateur de l'entrée de classement. |
| xuid | entier signé 32 bits | Obligatoire. Correspond à l'utilisateur de l'entrée de classement. |
| percentile | string | Obligatoire. Correspond à l'utilisateur de l'entrée de classement. |
| rank | string | Obligatoire. Correspond à l'utilisateur de l'entrée de classement. |
| values | array | Obligatoire. Chaque valeur séparée par des virgules correspond à une colonne du classement. |

## 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](https://docs.xbox.com/fr/reference/live/rest/additional/httpstatuscodes.md).

| Code | Expression de raison | Description |
| - | - | - |
| 200 | OK | La session a été récupérée avec succès. |
| 304 | Not Modified | |
| 400 | Bad Request | Le service n'a pas pu comprendre la requête incorrecte. Il s'agit généralement d'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. |
| 406 | Not Acceptable | La version de la ressource n'est pas prise en charge ; elle doit être rejetée par la couche MVC. |
| 408 | Request Timeout | Le service n'a pas pu comprendre la requête incorrecte. Il s'agit généralement d'un paramètre non valide. |

## En-têtes de réponse obligatoires

| En-tête | Type | Description |
| - | - | - |
| Content-Type | string | Type MIME du corps de la réponse. Exemples de valeurs : "application/json". |
| Content-Length | string | Nombre d'octets envoyés dans la réponse. Exemple de valeur : "232". |

## En-têtes de réponse facultatifs

| En-tête | Type | Description |
| - | - | - |
| ETag | string | Utilisé pour l'optimisation du cache. Exemple de valeur : "686897696a7c876b7e". |

## Corps de la réponse

Requête de classement social, sans pagination :

`https://leaderboards.xboxlive.com/users/xuid(2533274916402282)/scids/c1ba92a9-0000-0000-0000-000000000000/stats/EnemyDefeats/people/all?sort=descending`

### Exemple de réponse

```json theme={null}
{
    "pagingInfo": null,
    "leaderboardInfo": {
        "displayName": "Kills",
        "totalCount": 3,
        "columns": [
            {
                "displayName": "Kills",
                "statName": "enemydefeats",
                "type": "integer"
            }
        ]
    },
    "userList": [
        {
            "gamertag":"xxxSniper39",
            "xuid":"1234567890123555",
            "percentile":1.0,
            "rank":1,
            "values": [
                "47"
            ]
        },
        {
            "gamertag":"WarriorSaint",
            "xuid":"2533274916402282",
            "percentile":0.66,
            "rank":2,
            "values": [
                "42"
            ]
        },
        {
            "gamertag":"WhockaWhocka",
            "xuid":"1234567890123666",
            "percentile":0.33,
            "rank":3,
            "values": [
                "12"
            ]
        }
    ]
}

```

## Voir aussi

##### Parent

[/users/xuid(\{xuid})/scids/\{scid}/stats/\{statname)/people/\{all|favorite}](https://docs.xbox.com/fr/reference/live/rest/uri/leaderboard/uri-usersxuidscidstatnamepeople.md)


## Related topics

- [/users/xuid({xuid})/scids/{scid}/stats/{statname)/people/{all|favorite}](https://docs.xbox.com/fr/reference/live/rest/uri/leaderboard/uri-usersxuidscidstatnamepeople.md)
- [Vue d'ensemble des classements basés sur les événements](https://docs.xbox.com/fr/services/xbox-services/player-data/stats-leaderboards/event-based/live-leaderboards-eb-overview.md)
- [GET (/users/xuid({xuid})/scids/{scid}/stats)](https://docs.xbox.com/fr/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstatsget.md)
- [GET (/users/xuid({xuid})/scids/{scid}/stats?include=valuemetadata)](https://docs.xbox.com/fr/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstatsgetvaluemetadata.md)
- [/users/xuid({xuid})/scids/{scid}/stats](https://docs.xbox.com/fr/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstats.md)
