GET (/users/xuid()/achievements)

Obtiene la lista de logros definidos en el título, los desbloqueados por el usuario o los que el usuario tiene en curso. El dominio de estos URI es achievements.xboxlive.com.

Parámetros de URI
Parámetros de cadena de consulta
Autorización
Encabezados de solicitud obligatorios
Encabezados de solicitud opcionales
Cuerpo de la solicitud
Cuerpo de la respuesta

Parámetros de URI

Parámetro	Tipo	Descripción
xuid	Entero de 64 bits sin signo	Identificador de usuario de XBOX (XUID) del usuario a cuyo (recurso) se accede. Debe coincidir con el XUID del usuario autenticado.

Parámetros de cadena de consulta

| Parámetro| Obligatorio| Tipo| Descripción| | --- | --- | --- | --- | --- | --- | --- | | skipItems| No| Entero de 32 bits con signo| Devuelve los elementos que comienzan después del número de elementos indicado. Por ejemplo, skipItems=“3” recuperará los elementos a partir del cuarto elemento recuperado. | | continuationToken| No| string| Devuelve los elementos a partir del token de continuación indicado. | | maxItems| No| Entero de 32 bits con signo| Número máximo de elementos que se devuelven de la colección, que se puede combinar con skipItems y continuationToken para devolver un intervalo de elementos. El servicio puede proporcionar un valor predeterminado si maxItems no está presente y puede devolver menos de maxItems, incluso si aún no se ha devuelto la última página de resultados. | | titleId| No| string| Filtro para los resultados devueltos. Acepta uno o varios identificadores decimales de título delimitados por comas.| | unlockedOnly| No| Valor booleano| Filtro para los resultados devueltos. Si se establece en true, solo devolverá los logros desbloqueados por el usuario. El valor predeterminado es false.| | possibleOnly| No| Valor booleano| Filtro para los resultados devueltos. Si se establece en true, devolverá todos los resultados posibles pero sin los metadatos de desbloqueo: solo la información del logro procedente de XMS. El valor predeterminado es false.| | types| No| string| Filtro para los resultados devueltos. Puede ser “Persistent” o “Challenge”. El valor predeterminado incluye todos los tipos admitidos.| | orderBy| No| string| Especifica el orden en que se devuelven los resultados. Puede ser “Unordered”, “Title”, “UnlockTime” o “EndingSoon”. El valor predeterminado es “Unordered”.|

Autorización

| Notificación| ¿Obligatoria?| Descripción| Comportamiento si falta| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | User| El autor de la llamada es un usuario autorizado de XBOX LIVE.| El autor de la llamada debe ser un usuario válido en XBOX LIVE.| 403 Forbidden|

Encabezados de solicitud obligatorios

| Encabezado| Tipo| Descripción| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| string| Credenciales de autenticación para la autenticación HTTP. Valor de ejemplo: “XBL3.0 x=<userhash>;<token>”.|

Encabezados de solicitud opcionales

| Encabezado| Tipo| Descripción| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | X-RequestedServiceVersion| string| 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.| | x-xbl-contract-version| Entero de 32 bits sin signo| Si está presente y se establece en 2, se usará la versión V2 de esta API. De lo contrario, V1.| | Accept-Language| string| Lista de configuraciones regionales deseadas y alternativas (por ejemplo, fr-FR, fr, en-GB, en-WW, en-US). El servicio de logros recorrerá la lista hasta encontrar cadenas localizadas coincidentes. Si no encuentra ninguna, intenta hacer coincidir la ubicación definida en el token del usuario, que procede de la dirección IP del usuario. Si aun así no se encuentran cadenas localizadas coincidentes, usa las cadenas predeterminadas proporcionadas por el desarrollador o editor del título. |

Cuerpo de la solicitud

No se envían objetos en el cuerpo de esta solicitud.

Cuerpo de la respuesta

Si la llamada se realiza correctamente, el servicio devuelve una matriz de objetos Achievement (JSON) y un objeto PagingInfo (JSON).

Ejemplo de respuesta

{
    "achievements":
    [{
        "id":"3",
        "serviceConfigId":"b5dd9daf-0000-0000-0000-000000000000",
        "name":"Default NameString for Microsoft Achievements Sample Achievement 3",
        "titleAssociations":
        [{
                "name":"Microsoft Achievements Sample",
                "id":3051199919,
                "version":"abc"
        }],
        "progressState":"Achieved",
        "progression":
        {
                "achievementState":"Achieved",
                "requirements":null,
                "timeUnlocked":"2013-01-17T03:19:00.3087016Z",
        },
        "mediaAssets":
        [{
                "name":"Icon Name",
                "type":"Icon",
                "url":"http://www.xbox.com"
        }],
        "platform":"D",
        "isSecret":true,
        "description":"Default DescriptionString for Microsoft Achievements Sample Achievement 3",
        "lockedDescription":"Default UnachievedString for Microsoft Achievements Sample Achievement 3",
        "productId":"12345678-1234-1234-1234-123456789012",
        "achievementType":"Challenge",
        "participationType":"Individual",
        "timeWindow":
        {
                "startDate":"2013-02-01T00:00:00Z",
                "endDate":"2100-07-01T00:00:00Z"
        },
        "rewards":
        [{
                "name":null,
                "description":null,
                "value":"10",
                "type":"Gamerscore",
                "valueType":"Int"
        },
        {
                "name":"Default Name for InAppReward for Microsoft Achievements Sample Achievement 3",
                "description":"Default Description for InAppReward for Microsoft Achievements Sample Achievement 3",
                "value":"1",
                "type":"InApp",
                "valueType":"String"
        }],
        "estimatedTime":"06:12:14",
        "deeplink":"aWFtYWRlZXBsaW5r",
        "isRevoked":false
        }],
        "pagingInfo":
        {
                "continuationToken":null,
                "totalRecords":1
        }
}
         

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

GET (/users/xuid({xuid})/achievements)

GET (/users/xuid()/achievements)

Parámetros de URI

Parámetros de cadena de consulta

Autorización

Encabezados de solicitud obligatorios

Encabezados de solicitud opcionales

Cuerpo de la solicitud

Cuerpo de la respuesta

Ejemplo de respuesta

Consulte también

Elemento primario

Referencia

​GET (/users/xuid()/achievements)

​Parámetros de URI

​Parámetros de cadena de consulta

​Autorización

​Encabezados de solicitud obligatorios

​Encabezados de solicitud opcionales

​Cuerpo de la solicitud

​Cuerpo de la respuesta

​Ejemplo de respuesta

​Consulte también

Elemento primario

Referencia

GET (/users/xuid()/achievements)

Parámetros de URI

Parámetros de cadena de consulta

Autorización

Encabezados de solicitud obligatorios

Encabezados de solicitud opcionales

Cuerpo de la solicitud

Cuerpo de la respuesta

Ejemplo de respuesta

Consulte también