Skip to main content

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

依索引從清單中移除項目。 這些 URI 的網域是 eplists.xboxlive.com。

備註

從清單中移除項目。要移除的項目以其在清單中的索引表示,並在查詢字串參數 “indexes” 中識別。索引清單必須以逗號分隔,且單一呼叫最多只能傳遞 100 個索引。不過,如果未傳遞任何索引 (查詢字串參數為空),則會刪除整個清單的內容 (清單會保留但為空,版本號碼會繼續遞增)。移除項目之後,清單會進行「壓縮」,使索引的排序中不會留下空缺。 此呼叫要求在要求中包含 “If-Match:versionNumber” 標頭,其中 versionNumber 是檔案目前的版本號碼。如果未包含此標頭,或與清單目前的版本號碼不符,則會傳回 HTTP 412 - 前置條件失敗狀態碼,且回應本文會包含清單的最新中繼資料,其中包括目前的版本號碼。這是為了防止來自不同用戶端的更新互相覆蓋。

URI 參數

查詢字串參數

| 參數| 類型| 描述| | --- | --- | --- | --- | --- | --- | | indexes| 字串| 零或正整數。數字不需要連續。例如,查詢參數 indexes=1,8 會移除索引 1 和 8 的項目。如果未指定任何索引,則會刪除整個清單。|

要求本文

此呼叫的要求本文必須為空。

HTTP 狀態碼

服務會傳回本節中的其中一個狀態碼,以回應在此資源上使用此方法所提出的要求。如需 XBOX Live 服務所使用之標準 HTTP 狀態碼的完整清單,請參閱標準 HTTP 狀態碼。 | 代碼| 原因片語| 描述| | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 200| OK | 要求已成功完成。回應本文應包含所要求的資源 (適用於 GET)。POST 和 PUT 要求會收到最新的清單中繼資料 (清單版本、計數等)。| | 201| Created | 已建立新清單。這會在首次插入清單時傳回。回應包含清單的最新中繼資料,且 location 標頭包含清單的 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 - 前置條件失敗代碼。(選用) 也可用於 GET,如果存在此標頭且傳入的版本與清單目前的版本相符,則不會傳回任何清單資料,並會傳回 HTTP 304 - Not Modified 代碼。 |

回應本文

如果呼叫成功,服務會傳回清單的最新中繼資料。

範例回應

另請參閱

上層
統一資源識別項 (URI) 參考
Last modified on October 6, 2026