> ## 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})

Devuelve una tabla de clasificación social mediante la clasificación de los valores de estadística (puntuaciones) de todos los contactos conocidos del usuario actual o solo de los contactos que ese usuario ha designado como personas favoritas.
El dominio de estos URI es `leaderboards.xboxlive.com`.

* [Comentarios](#ID4EV)
* [Parámetros de URI](#ID4EAB)
* [Parámetros de cadena de consulta](#ID4ELB)
* [Autorización](#ID4EQD)
* [Encabezados de solicitud obligatorios](#ID4EGE)
* [Encabezados de solicitud opcionales](#ID4EXF)
* [Cuerpo de la solicitud](#ID4ETG)
* [Códigos de estado HTTP](#ID4ECEAC)
* [Encabezados de respuesta obligatorios](#ID4E1HAC)
* [Encabezados de respuesta opcionales](#ID4EDJAC)
* [Cuerpo de la respuesta](#ID4EDKAC)

## Comentarios

Las API de tablas de clasificación son todas de solo lectura y, por lo tanto, solo admiten el verbo GET (a través de HTTPS). Reflejan "páginas" clasificadas y ordenadas de estadísticas de jugador indexadas que se derivan de las estadísticas de usuario individuales que se escribieron a través del sistema de datos de jugador. Los índices completos de una tabla de clasificación pueden ser bastante grandes y los autores de llamadas nunca pedirán verlos en su totalidad; por lo tanto, este URI admite varios argumentos de cadena de consulta que permiten al autor de la llamada especificar qué tipo de vista quiere ver de esa tabla de clasificación.

Las operaciones GET no modifican ningún recurso, por lo que producirán los mismos resultados si se ejecutan una o varias veces.

## Parámetros de URI

| Parámetro | Tipo | Descripción |
| - | - | - |
| xuid | string | Identificador del usuario. |
| scid | string | Identificador de la configuración de servicio que contiene el recurso al que se accede. |
| statname | string | Identificador único del recurso de estadística de usuario al que se accede. |
| all or favorite | enumeración | Indica si se clasifican los valores de estadística (puntuaciones) de todos los contactos conocidos del usuario actual o solo de los contactos que ese usuario ha designado como personas favoritas. |

## Parámetros de cadena de consulta

| Parámetro | Tipo | Descripción |
| - | - | - |
| maxItems | Entero de 32 bits sin signo | Número máximo de registros de la tabla de clasificación que se devuelven en una página de resultados. Si no se especifica, se devolverá un número predeterminado (10). El valor máximo de maxItems aún no está definido, pero queremos evitar conjuntos de datos grandes, por lo que este valor probablemente debería apuntar al conjunto más grande que una interfaz de usuario pueda controlar por llamada. |
| skipToRank | Entero de 32 bits sin signo | Devuelve una página de resultados que comienza en la posición especificada de la tabla de clasificación. El resto de los resultados estará ordenado por posición. Esta cadena de consulta puede devolver un token de continuación que se puede pasar en una consulta posterior para obtener "la página siguiente" de resultados. |
| skipToUser | string | Devuelve una página de resultados de la tabla de clasificación en torno al xuid del jugador especificado, independientemente de la posición o puntuación de ese usuario. La página se ordenará por posición de percentil con el usuario especificado en la última posición de la página para las vistas predefinidas, o en el medio para las vistas de tabla de clasificación de estadísticas. No se proporciona **continuationToken** para este tipo de consulta. |
| continuationToken | string | Si una llamada anterior devolvió un **continuationToken**, el autor de la llamada puede devolver ese token "tal cual" en una cadena de consulta para obtener la página siguiente de resultados. |
| sort | string | Especifica si la lista de jugadores se clasifica en orden de valor de menor a mayor ("ascending") o de mayor a menor ("descending"). Es un parámetro opcional; el valor predeterminado es el orden descendente. |

## Autorización

Se requiere autorización mediante xuid.

Hay lógica de autorización implementada para escenarios de aislamiento de contenido y control de acceso.

Tanto las tablas de clasificación como las estadísticas de usuario se pueden leer desde clientes de cualquier plataforma, siempre que el autor de la llamada envíe un token XSTS válido con la solicitud. Obviamente, las escrituras están limitadas a los clientes compatibles con el sistema de datos de jugador.

Los desarrolladores de títulos pueden marcar las estadísticas como abiertas o restringidas con Partner Center. Las tablas de clasificación son estadísticas abiertas. Las estadísticas abiertas son accesibles desde Smartglass, así como desde aplicaciones de iOS, Android, Windows, Windows Phone y web, siempre que el usuario esté autorizado en el sandbox. La autorización del usuario en un sandbox se administra mediante Partner Center.

## Encabezados de solicitud obligatorios

| Encabezado | Descripción |
| - | - |
| Authorization | Cadena. Credenciales de autenticación para la autenticación HTTP. Valor de ejemplo: "XBL3.0 x=\<userhash>;\<token>". |
| Content-Type | Cadena. El tipo MIME del cuerpo de la solicitud. Valor de ejemplo: "application/json". |
| X-RequestedServiceVersion | Nombre o número de compilación del servicio de XBOX Live al que se debe dirigir esta solicitud. La solicitud solo se enrutará a ese servicio tras comprobar la validez del encabezado, las notificaciones del token de autenticación, etc. Valor predeterminado: 1. |
| Accept | Cadena. Valores de Content-Type aceptables. Valor de ejemplo: "application/json". |

## Encabezados de solicitud opcionales

| Encabezado | Descripción |
| - | - |
| If-None-Match | Cadena. Etiqueta de entidad, que se usa si el cliente admite el almacenamiento en caché. Valor de ejemplo: "686897696a7c876b7e". |

## Cuerpo de la solicitud

Para maximizar la capacidad de cualquier autor de llamada de entender los datos que recibe y mostrarlos correctamente, cada valor de estadística de cada usuario se devolverá como una cadena en el formato en que debe mostrarse, con el formato correspondiente a la configuración regional especificada en el encabezado accept-language de la solicitud. También se devolverá un "nombre para mostrar" localizado para el statname de esa tabla de clasificación.

### Miembros obligatorios

| Miembro | Tipo | Descripción |
| - | - | - |
| **pagingInfo** | sección | Opcional. Se devuelve cuando la posición de la última entrada de la página es inferior a totalItems. Esta sección tampoco se devuelve cuando se especifica skipToUser en la solicitud. |
| continuationToken | string | Obligatorio. Especifica qué valor pasar de nuevo en el parámetro de consulta "continuationToken" para obtener la página siguiente de resultados de ese URI si se desea. Si no se devuelve pagingInfo, no hay una "página siguiente" de datos que obtener. |
| totalItems | Entero de 64 bits sin signo | Obligatorio. Número total de entradas de la tabla de clasificación. |
| **leaderboardInfo** | sección | Obligatorio. Siempre se devuelve. Contiene los metadatos de la tabla de clasificación solicitada. |
| displayName | string | Obligatorio. Nombre para mostrar localizado de la tabla de clasificación predefinida. Valor de ejemplo: "Total flags captured". |
| totalCount | string | Obligatorio. Número total de entradas de la tabla de clasificación. |
| columns | array | Obligatorio. |
| displayName | string | Obligatorio. Corresponde a una columna de la tabla de clasificación. |
| statName | string | Obligatorio. Corresponde a una columna de la tabla de clasificación. |
| type | string | Obligatorio. Corresponde a una columna de la tabla de clasificación. |
| **userList** | sección | Obligatorio. Siempre se devuelve. Contiene las puntuaciones reales de los usuarios de la tabla de clasificación solicitada. |
| gamertag | string | Obligatorio. Corresponde al usuario de la entrada de la tabla de clasificación. |
| xuid | Entero de 32 bits con signo | Obligatorio. Corresponde al usuario de la entrada de la tabla de clasificación. |
| percentile | string | Obligatorio. Corresponde al usuario de la entrada de la tabla de clasificación. |
| rank | string | Obligatorio. Corresponde al usuario de la entrada de la tabla de clasificación. |
| values | array | Obligatorio. Cada valor separado por comas corresponde a una columna de la tabla de clasificación. |

## Códigos de estado HTTP

El servicio devuelve uno de los códigos de estado de esta sección en respuesta a una solicitud realizada con este método en este recurso. Para obtener una lista completa de los códigos de estado HTTP estándar que se usan con los servicios de XBOX Live, consulte [Códigos de estado HTTP estándar](https://docs.xbox.com/es/reference/live/rest/additional/httpstatuscodes.md).

| Código | Frase de motivo | Descripción |
| - | - | - |
| 200 | OK | La sesión se recuperó correctamente. |
| 304 | Not Modified | |
| 400 | Bad Request | El servicio no pudo interpretar una solicitud con formato incorrecto. Normalmente, un parámetro no válido. |
| 401 | Unauthorized | La solicitud requiere autenticación del usuario. |
| 403 | Forbidden | La solicitud no está permitida para el usuario o el servicio. |
| 404 | Not Found | No se pudo encontrar el recurso especificado. |
| 406 | Not Acceptable | La versión del recurso no es compatible; la capa MVC debería rechazarla. |
| 408 | Request Timeout | El servicio no pudo interpretar una solicitud con formato incorrecto. Normalmente, un parámetro no válido. |

## Encabezados de respuesta obligatorios

| Encabezado | Tipo | Descripción |
| - | - | - |
| Content-Type | string | El tipo MIME del cuerpo de la respuesta. Valores de ejemplo: "application/json". |
| Content-Length | string | El número de bytes que se envían en la respuesta. Valor de ejemplo: "232". |

## Encabezados de respuesta opcionales

| Encabezado | Tipo | Descripción |
| - | - | - |
| ETag | string | Se usa para la optimización de la caché. Valor de ejemplo: "686897696a7c876b7e". |

## Cuerpo de la respuesta

Solicitud de tabla de clasificación social, sin paginación:

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

### Ejemplo de respuesta

```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"
            ]
        }
    ]
}

```

## Consulte también

##### Elemento primario

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


## Related topics

- [/users/xuid({xuid})/scids/{scid}/stats/{statname)/people/{all|favorite}](https://docs.xbox.com/es/reference/live/rest/uri/leaderboard/uri-usersxuidscidstatnamepeople.md)
- [Información general sobre las tablas de clasificación basadas en eventos](https://docs.xbox.com/es/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/es/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstatsget.md)
- [GET (/users/xuid({xuid})/scids/{scid}/stats?include=valuemetadata)](https://docs.xbox.com/es/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstatsgetvaluemetadata.md)
- [/users/xuid({xuid})/scids/{scid}/stats](https://docs.xbox.com/es/reference/live/rest/uri/userstats/uri-usersxuidscidsscidstats.md)
