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

获取成就的详细信息。 这些 URI 的域是 achievements.xboxlive.com

URI 参数

参数 类型 说明
xuid 64 位无符号整数 正在访问其资源的用户的 Xbox 用户 ID (XUID)。 必须与经过身份验证的用户的 XUID 匹配。
scid GUID 正在访问其成就的服务配置的唯一标识符。
achievementid 32 位无符号整数 正在访问的成就的唯一(在指定 SCID 内)标识符。

授权

已使用授权声明 声明 必填? 说明 缺少时的行为
用户 正在为其发起请求的 Xbox LIVE 上的有效用户。 403 已禁止
游戏 调用游戏。 取决于 AuthZ。 自 2013 年 5 月 1 日起,AuthZ 将不提供缺失的声明,因此会拒绝对未标记为公共的任何 SCID 的访问。
沙盒 应从中检索结果的沙盒。 取决于 AuthZ。 自 2013 年 5 月 1 日起,AuthZ 将不提供缺失的默认声明。

隐私设置对资源的影响

隐私设置对资源的影响 请求用户 目标用户的隐私设置 行为
- 如文中所述。
好友 所有人 OK
好友 仅好友 OK
好友 已阻止 已禁止。
非好友用户 所有人 OK
非好友用户 仅好友 已禁止。
非好友用户 已阻止 已禁止。
第三方站点 所有人 OK
第三方站点 仅好友 已禁止。
第三方站点 已阻止 已禁止。

必需请求标头

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

可选请求标头

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

请求正文

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

HTTP 状态代码

服务返回此部分中的状态代码之一,以响应使用此方法对此资源发出的请求。 对于用于 Xbox Live 服务的标准 HTTP 状态代码的完整列表,请参阅标准 HTTP 状态代码

代码 原因短语 说明
200 OK 会话成功检索。
301 已永久移动 服务已移至其他 URI。
307 临时重定向 此资源的 URI 已暂时更改。
400 无效请求 服务无法理解格式错误的请求。 通常是无效参数。
401 未授权 请求需要用户身份验证。
403 已禁止 用户或服务不允许此请求。
404 未找到 找不到指定资源。
406 不可接受 资源版本不受支持;应由 MVC 层拒绝。
408 请求超时 请求完成时间太长。
410 已停用 请求的资源不再可用。

响应正文

示例响应

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

另请参阅

父级

/users/xuid({xuid})/achievements/{scid}/{achievementid}