DELETE /users/xuid(xuid)/lists/PINS//RemoveItems

按索引从列表中移除项。这些 URI 的域为 eplists.xboxlive.com。

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

备注

从列表中移除项。要移除的项通过其在列表中的索引指示,并在查询字符串参数 “indexes” 中标识。索引列表必须以逗号分隔,并且单次调用最多只能传递 100 个索引。但是,如果未传递任何索引(查询字符串参数为空),则将删除整个列表的内容(列表将保留但为空,版本号会继续递增)。移除项之后,列表会被“压缩”,以便索引顺序中不会留下空洞。此调用要求在请求中包含 “If-Match:versionNumber” 标头,其中 versionNumber 为文件的当前版本号。如果未包含,或者与当前列表版本号不匹配,则将返回 HTTP 412 - precondition failed 状态代码,并且响应正文将包含该列表的最新元数据(其中包含当前版本号)。这样做是为了防止来自不同客户端的更新相互覆盖。

URI 参数

参数	类型	说明
XUID	string	用户的 XUID。
listname	string	要操作的列表的名称。

查询字符串参数

参数	类型	说明
indexes	string	零或正整数。这些数字不必是连续的。例如,查询参数 indexes=1,8 将移除索引 1 和 8 处的项。如果未指定任何索引,则将删除整个列表。

请求正文

此调用的请求正文必须为空。

HTTP 状态代码

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

代码	原因短语	说明
200	OK	请求已成功完成。响应正文应包含所请求的资源(对于 GET)。POST 和 PUT 请求将收到最新的列表元数据(列表版本、计数等)。
201	Created	已创建新列表。这是在向列表进行初始插入时返回的。响应包含列表的最新元数据,并且位置标头包含该列表的 URI。
304	Not Modified	对 GET 返回。表示客户端已拥有该列表的最新版本。服务将 If-Match 标头中的值与列表版本进行比较。如果相等,则返回 304 且不带任何数据。
400	Bad Request	请求格式错误。可能是 URI 或查询字符串参数的值或类型无效。也可能是由于缺少必需的参数或数据值,或者请求指示了缺少或无效的 API 版本。请参见 X-XBL-Contract-Version 标头。
401	Unauthorized	请求需要用户身份验证。
403	Forbidden	不允许该用户或服务发出请求。
404	Not Found	调用者无权访问该资源。这表示尚未创建这样的列表。
412	Precondition Failed	表示列表的版本已更改,并且修改请求失败。修改请求是插入、更新或移除操作。服务会检查 If-Match 标头中的列表版本。如果与列表的当前版本不匹配,则该操作失败,并返回此代码以及当前列表的元数据(包括当前版本)。
500	Internal Server Error	由于服务器端错误,服务正在拒绝请求。
501	Not Implemented	调用者请求了尚未在服务器上实现的 URI。(当前仅在对未列入允许列表的列表名称发出请求时使用。)
503	Service Unavailable	服务器拒绝请求,通常是由于负载过大。经过延迟后(请参见 Retry-after 标头),可以重试请求。

必需的请求标头

标头	说明
Authorization	包含用于对请求进行身份验证和授权的 STS 令牌。必须是来自 XSTS 服务的令牌,并且包含 XUID 作为其中一项声明。
X-XBL-Contract-Version	指定正在请求的 API 版本(正整数)。Pins 支持版本 2。如果缺少此标头或值不受支持,则服务将返回 400 - Bad request,状态描述为 “Unsupported or missing contract version header”。
Content-Type	指定请求/响应正文的内容是 json 还是 xml。支持的值为 “application/json” 和 “application/xml”。
If-Match	发出修改请求时,此标头必须包含列表的当前版本号。修改请求使用 PUT、POST 或 DELETE 谓词。如果 “If-Match” 标头中的版本与列表的当前版本不匹配,则请求将被拒绝并返回 HTTP 412 - precondition failed 代码。(可选)也可用于 GET,如果存在并且传入的版本与当前列表版本匹配,则不返回任何列表数据并返回 HTTP 304 - Not Modified 代码。

响应正文

如果调用成功,服务将返回列表的最新元数据。

响应示例

{
        "ListVersion":  1,
        "ListCount":  1,
        "MaxListSize": 200,
        "AllowDuplicates": "true",
        "AccessSetting":  "OwnerOnly"
        }

      

另请参阅

父主题

通用资源标识符 (URI) 参考

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

DELETE /users/xuid(xuid)/lists/PINS/{listname}/RemoveItems

DELETE /users/xuid(xuid)/lists/PINS//RemoveItems

备注

URI 参数

查询字符串参数

请求正文

HTTP 状态代码

必需的请求标头

响应正文

响应示例

另请参阅

父主题

​DELETE /users/xuid(xuid)/lists/PINS//RemoveItems

​备注

​URI 参数

​查询字符串参数

​请求正文

​HTTP 状态代码

​必需的请求标头

​响应正文

​响应示例

​另请参阅

父主题

DELETE /users/xuid(xuid)/lists/PINS//RemoveItems

备注

URI 参数

查询字符串参数

请求正文

HTTP 状态代码

必需的请求标头

响应正文

响应示例

另请参阅