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

项目
05/09/2023

获取在游戏上定义的成就列表，也就是用户解锁的成就列表或用户正在进行的成就列表。这些 URI 的域是 achievements.xboxlive.com。

URI 参数
查询字符串参数
授权
必需请求标头
可选请求标头
请求正文
响应正文

URI 参数

参数	类型	说明
xuid	64 位无符号整数	正在访问其（资源）的用户的 Xbox 用户 ID (XUID)。必须与经过身份验证的用户的 XUID 匹配。

查询字符串参数

参数	必需	类型	说明
skipItems	否	32 位有符号整数	返回在给定项目数之后开始的项目。例如，skipItems="3" 将检索从检索到的第 4 个项目开始的项目。
continuationToken	否	字符串	返回从给定延续令牌开始的项目。
maxItems	否	32 位有符号整数	要从集合返回的项目的最大数量，这可与 skipItems 和 continuationToken 结合使用来返回一系列项目。如果 maxItems 不存在，服务可能会提供默认值，并可能返回少于 maxItems 个的项目，即使尚未返回最后一页结果也是如此。
titleId	否	字符串	用于筛选返回结果的筛选器。接受一个或多个逗号分隔的十进制游戏标识符。
unlockedOnly	否	布尔值	用于筛选返回结果的筛选器。如果设置为 true，将只为用户返回解除锁定的成就。默认为 false。
possibleOnly	否	布尔值	用于筛选返回结果的筛选器。如果设置为 true，将返回所有可能结果，但不包括解除锁定的元数据 - 只包括来自 XMS 的成就信息。默认为 false。
types	否	字符串	用于筛选返回结果的筛选器。可以是“Persistent”或“Challenge”。默认为所有受支持的类型。
orderBy	否	字符串	指定返回结果的顺序。可以是“Unordered”、“Title”、“UnlockTime”或“EndingSoon”。默认为“Unordered”。

授权

声明	必填？	说明	缺少时的行为
用户	调用方是授权的 Xbox LIVE 用户。	调用方必须是 Xbox LIVE 上的有效用户。	403 已禁止

必需请求标头

标头	类型	说明
授权	字符串	HTTP 身份验证的身份验证凭据。示例值：“XBL3.0 x=<userhash>;<token>”。

可选请求标头

标头	类型	说明
X-RequestedServiceVersion	字符串	此请求应定向到的 Xbox LIVE 服务的版本名称/版本号。在验证标头的有效性、身份验证令牌中的声明等信息之后，请求将仅路由到该服务。默认值：1。
x-xbl-contract-version	32 位无符号整数	如果存在并设置为 2，则将使用此 API 的 V2 版本。否则，使用 V1 版本。
Accept-Language	字符串	所需区域设置和回退（例如，fr-FR、fr、en-GB、en-WW、en-US）的列表。成就服务将查找整个列表，直到找到匹配的本地化字符串。如果未找到，它将尝试匹配在用户令牌中定义的位置，此位置来自用户的 IP 地址。如果仍未找到匹配的本地化字符串，它将使用游戏开发者/发布者提供的默认字符串。

请求正文

对象不会在此请求的正文中发送。

响应正文

如果调用成功，该服务会返回一系列 Achievement (JSON) 对象和一个 PagingInfo (JSON) 对象。

示例响应

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