GET (/users/{ownerId}/people)

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

备注
URI 参数
查询字符串参数
授权
必需的请求标头
可选的请求标头
请求正文
HTTP 状态代码
必需的响应标头
响应正文

备注

GET 操作不会修改任何资源,因此无论执行一次还是多次都会产生相同的结果。

URI 参数

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

查询字符串参数

参数	类型	说明
view	string	返回与某个视图关联的人员。默认值为 “all”。可能的值为:All - 返回用户人员列表中的所有人员。这是默认值。 Favorite - 返回用户人员列表中具有 Favorite 属性的所有人员。 LegacyXboxLiveFriends - 返回用户人员列表中同时也是旧版 XBOX Live 好友的所有人员。注意: 如果调用用户与所有者用户不同,则仅支持 All 值。
startIndex	32 位无符号整数	从给定索引开始返回项。
maxItems	32 位无符号整数	从起始索引开始,要从集合中返回的最大人员数。如果不存在 maxItems,服务可能会提供默认值,并且返回的项数可能少于 maxItems(即使尚未返回最后一页结果)。

授权

类型	是否必需	说明	缺失时的响应
XUID	是	调用方拥有用户的 XBOX 用户 ID (XUID)。	401 Unauthorized

必需的请求标头

标头	说明
Authorization	String。XBOX Live 的授权数据。这通常是经过加密的 XSTS 令牌。示例值:XBL3.0 x=<userhash>;<token>。

可选的请求标头

标头	说明
X-RequestedServiceVersion	此请求应发送到的 XBOX Live 服务的生成名称/编号。仅在验证标头的有效性、身份验证令牌中的声明等之后,请求才会被路由到该服务。默认值:1。
Accept	String。调用方在响应中接受的 Content-Type。所有响应均为 application/json。

请求正文

此请求正文中未发送任何对象。

HTTP 状态代码

服务针对使用此方法对此资源发出的请求,返回本节中的一个状态代码。有关 XBOX Live 服务使用的标准 HTTP 状态代码的完整列表,请参阅标准 HTTP 状态代码。

代码	原因短语	说明
200	OK	成功。
400	Bad Request	查询参数或用户 ID 格式错误。
403	Forbidden	无法从授权标头解析 XUID 声明。

必需的响应标头

标头	类型	说明
Content-Length	32 位无符号整数	响应正文的长度(以字节为单位)。示例值:22。
Content-Type	string	响应正文的 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

​GET (/users/{ownerId}/people)

​备注

​URI 参数

​查询字符串参数

​授权

​必需的请求标头

​可选的请求标头

​请求正文

​HTTP 状态代码

​必需的响应标头

​响应正文

​示例响应

​另请参阅