GET (/users/xuid(xuid)/lists/PINS/)
傳回清單的內容。 這些 URI 的網域是eplists.xboxlive.com。
備註
傳回資料中的 listCount 欄位表示服務所維護的整個清單中有多少個項目,因此可用來判斷清單的結尾位置,而此數字可能與要求所傳回的特定項目數不同。 如果清單尚不存在,則結果不會包含任何清單項目,listCount 會是零,listVersion 也會是零。URI 參數
查詢字串參數
| 參數| 類型| 描述| | --- | --- | --- | --- | --- | --- | | skipItems| 32 位元帶正負號的整數| 選用。傳回結果之前,在列舉中要略過的項目數。預設值:0。| | maxItems| 32 位元帶正負號的整數| 選用。要傳回的項目數上限。如果要求中未指定上限,預設為 25 個項目。服務不會對此值設定上限;如果此值大於清單中的項目數,則會傳回所有項目且不會發生錯誤。| | filterItemId| 字串| 選用。指定要在清單中尋找的項目。傳回清單中該項目的所有執行個體。可讓用戶端快速判斷項目是否在清單中以及位於何處。對於大型清單很方便,無需逐一查看整個清單即可判斷項目的所有執行個體。預設值:null。| | filterContentType| 字串| 選用。指定要傳回的內容類型清單,以逗號分隔 (不會傳回不在清單中的類型)。用於只從清單中取得特定內容類型。此篩選條件使用以逗號分隔的內容類型清單。(可在一次呼叫中查詢多個內容類型。) 支援的內容類型包括 Entertainment Discovery Services (EDS) 所定義的所有媒體類型。預設值:null (所有內容類型)。| | filterDeviceType| 字串| 選用。指定要傳回的裝置類型清單,以逗號分隔 (不會傳回不在清單中的類型)。篩選傳回集合,只傳回從特定裝置類型集合插入的項目。此篩選條件使用以逗號分隔的裝置類型清單 (可在一次呼叫中查詢多個裝置類型)。可能的值:XboxOne、MCapensis、WindowsPhone、WindowsPhone7、Web、PC、MoLive。預設值:null (所有內容類型)。|授權
此呼叫預期 Authorization 標頭中有 XSTS SAML 權杖。該 SAML 權杖中必須存在 Xuid 宣告,以識別呼叫端。此值用於判斷呼叫端是否具有相關清單資料的存取權限。清單本身也會以 Xuid 識別,並包含在清單的 URI 中。藉此,我們未來可能會支援清單的共用存取,但目前尚未提供此功能。目前,使用者存取的所有清單都是使用者自己的清單,沒有共用存取。因此,URI 中的 Xuid 必須與 SAML 宣告權杖中的 Xuid 相符。注意:
目前同時支援 XBL Auth 2.0 和 3.0 權杖。
