GET (/users/{ownerId}/people)

获取调用方的人脉集合。 这些 URI 的域是 social.xboxlive.com

备注

GET 操作不会修改任何资源,因此,如果执行一次或多次,这将产生相同结果。

URI 参数

参数 类型 说明
ownerId 字符串 正在访问其资源的用户的标识符。 必须与经过身份验证的用户匹配。 可能的值为“me”、xuid({xuid}) 或 gt({gamertag})。

查询字符串参数

参数 类型 说明
视图 字符串 返回与查看关联的用户。 默认值为“all”。 可能的值为:
  • 所有 - 返回用户的人员列表中的所有人员。 这是默认值。
  • 收藏夹 - 返回具有“收藏夹”属性的用户人员列表中的所有人员。
  • LegacyXboxLiveFriends - 返回用户人员列表中同时也是旧版 Xbox LIVE 好友的所有人员。

  • 注意:如果调用用户与负责人用户不同,则仅支持 All 值。
startIndex 32 位无符号整数 返回从给定索引开始的项目。
maxItems 32 位无符号整数 要从起始索引开始的集合返回的人员的最大数。 如果 maxItems 不存在,服务可能会提供默认值,并可能返回少于 maxItems 个的项目(即使尚未返回最后一页结果也是如此)。

授权

类型 必需 说明 缺少时的响应
XUID 调用方具有用户的 Xbox 用户 ID (XUID)。 401 未授权

必需请求标头

标头 说明
授权 字符串。 Xbox LIVE 的授权数据。 这通常是加密的 XSTS 令牌。 示例值:XBL3.0 x=<userhash>;<token>

可选请求标头

标头 说明
X-RequestedServiceVersion 此请求应定向到的 Xbox LIVE 服务的版本名称/版本号。 在验证标头的有效性、身份验证令牌中的声明等信息之后,请求将仅路由到该服务。默认值:1。
Accept 字符串。 调用方在响应中接受的 Content-Type。 所有响应均为 application/json

请求正文

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

HTTP 状态代码

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

代码 原因短语 说明
200 OK 成功。
400 无效的请求 查询参数或用户 ID 格式错误。
403 已禁止 XUID 声明无法从授权标头分析。

必需响应标头

标头 类型 说明
Content-Length 32 位无符号整数 响应正文的长度(以字节为单位)。 示例值:22。
Content-Type 字符串 响应正文的 MIME 类型。 将始终是 application/json

响应正文

如果调用成功,服务将在调用方的人员集合中返回人员的总数,以及包含调用方人员集合的数组。 请参阅 PeopleList (JSON)

示例响应

{
    "people": [
        {
            "xuid": "2603643534573573",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573572",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573577",
            "isFollowingCaller": false,
            "isFavorite": false
        },
    ],
    "totalCount": 3
}

另请参阅

父级

/users/{ownerId}/people