GET (/users/xuid()/achievements)

Obtient la liste des succès définis pour le titre, de ceux déverrouillés par l’utilisateur ou de ceux en cours pour l’utilisateur. Le domaine de ces URI est achievements.xboxlive.com.

Paramètres d’URI
Paramètres de chaîne de requête
Autorisation
En-têtes de requête obligatoires
En-têtes de requête facultatifs
Corps de la requête
Corps de la réponse

Paramètres d’URI

Paramètre	Type	Description
xuid	entier non signé 64 bits	ID utilisateur XBOX (XUID) de l’utilisateur dont la (ressource) est consultée. Doit correspondre au XUID de l’utilisateur authentifié.

Paramètres de chaîne de requête

| Paramètre| Obligatoire| Type| Description| | --- | --- | --- | --- | --- | --- | --- | | skipItems| Non| entier signé 32 bits| Retourne les éléments à partir du nombre d’éléments donné. Par exemple, skipItems=“3” récupère les éléments à partir du quatrième élément récupéré. | | continuationToken| Non| string| Retourne les éléments à partir du jeton de continuation donné. | | maxItems| Non| entier signé 32 bits| Nombre maximal d’éléments à retourner à partir de la collection, qui peut être combiné avec skipItems et continuationToken pour retourner une plage d’éléments. Le service peut fournir une valeur par défaut si maxItems n’est pas présent, et peut retourner moins de maxItems éléments, même si la dernière page de résultats n’a pas encore été retournée. | | titleId| Non| string| Filtre pour les résultats retournés. Accepte un ou plusieurs identificateurs de titre décimaux séparés par des virgules.| | unlockedOnly| Non| Valeur booléenne| Filtre pour les résultats retournés. Si la valeur est true, seuls les succès déverrouillés pour l’utilisateur sont retournés. La valeur par défaut est false.| | possibleOnly| Non| Valeur booléenne| Filtre pour les résultats retournés. Si la valeur est true, tous les résultats possibles sont retournés, mais pas les métadonnées de déverrouillage, uniquement les informations sur les succès provenant de XMS. La valeur par défaut est false.| | types| Non| string| Filtre pour les résultats retournés. Peut être “Persistent” ou “Challenge”. Par défaut, tous les types pris en charge.| | orderBy| Non| string| Spécifie l’ordre dans lequel les résultats sont retournés. Peut être “Unordered”, “Title”, “UnlockTime” ou “EndingSoon”. La valeur par défaut est “Unordered”.|

Autorisation

| Revendication| Obligatoire ?| Description| Comportement en cas d’absence| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | User| L’appelant est un utilisateur XBOX LIVE autorisé.| L’appelant doit être un utilisateur valide sur XBOX LIVE.| 403 Forbidden|

En-têtes de requête obligatoires

| En-tête| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization| string| Informations d’identification pour l’authentification HTTP. Exemple de valeur : “XBL3.0 x=<userhash>;<token>”.|

En-têtes de requête facultatifs

| En-tête| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | X-RequestedServiceVersion| string| 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.| | x-xbl-contract-version| entier non signé 32 bits| Si cet en-tête est présent et défini sur 2, la version V2 de cette API est utilisée. Sinon, V1.| | Accept-Language| string| Liste des paramètres régionaux souhaités et des paramètres de secours (par exemple, fr-FR, fr, en-GB, en-WW, en-US). Le service Achievements parcourt la liste jusqu’à ce qu’il trouve des chaînes localisées correspondantes. S’il n’en trouve aucune, il tente de faire correspondre l’emplacement défini dans le jeton utilisateur, qui provient de l’adresse IP de l’utilisateur. S’il ne trouve toujours aucune chaîne localisée correspondante, il utilise les chaînes par défaut fournies par le développeur/éditeur du titre. |

Corps de la requête

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

Corps de la réponse

Si l’appel réussit, le service retourne un tableau d’objets Achievement (JSON) et un objet PagingInfo (JSON).

Exemple de réponse

{
    "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)

Paramètres d’URI

Paramètres de chaîne de requête

Autorisation

En-têtes de requête obligatoires

En-têtes de requête facultatifs

Corps de la requête

Corps de la réponse

Exemple de réponse

Voir aussi

Parent

Référence

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

​Paramètres d’URI

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

​Autorisation

​En-têtes de requête obligatoires

​En-têtes de requête facultatifs

​Corps de la requête

​Corps de la réponse

​Exemple de réponse

​Voir aussi

Parent

Référence

GET (/users/xuid()/achievements)

Paramètres d’URI

Paramètres de chaîne de requête

Autorisation

En-têtes de requête obligatoires

En-têtes de requête facultatifs

Corps de la requête

Corps de la réponse

Exemple de réponse

Voir aussi