GET (/users/xuid(xuid)/lists/PINS/)
リストの内容を返します。 これらの URI のドメインはeplists.xboxlive.com です。
備考
返されるデータの listCount フィールドは、サービスによって管理されているリスト全体のアイテム数を示します。したがって、リストの終端がどこかを判定するために使用でき、これはリクエストで返された具体的なアイテムの数とは異なる可能性があります。 リストがまだ存在しない場合、結果にはリスト アイテムは含まれず、listCount は 0、listVersion も 0 になります。URI パラメーター
クエリ文字列パラメーター
| パラメーター| 型| 説明| | --- | --- | --- | --- | --- | --- | | skipItems| 32 ビット符号付き整数| 任意。結果を返す前に列挙でスキップするアイテムの数。既定値: 0。| | maxItems| 32 ビット符号付き整数| 任意。返すアイテムの最大数。リクエストで最大数が指定されない場合の既定は 25 アイテムです。サービスはこの値の上限を設けていません。値がリスト内のアイテム数を超える場合、エラーなしですべてのアイテムが返されます。| | filterItemId| string| 任意。リスト内で検索するアイテムを指定します。リスト内のそのアイテムのすべての出現箇所を返します。クライアントはアイテムがリスト内に存在するかとその場所を素早く判定できます。大きなリストで、リスト全体を反復せずに、あるアイテムのすべての出現箇所を特定するのに便利です。既定値: null。| | filterContentType| string| 任意。返すコンテンツ タイプのカンマ区切りリストを指定します (リストにない型は返しません)。リストから特定のコンテンツ タイプのみを取得するために使用します。このフィルターにはコンテンツ タイプのカンマ区切りリストが使用されます (1 回の呼び出しで複数のコンテンツ タイプを問い合わせできます)。サポートされるコンテンツ タイプには Entertainment Discovery Services (EDS) で定義されるすべてのメディア タイプが含まれます。既定値: null (すべてのコンテンツ タイプ)。| | filterDeviceType| string| 任意。返すデバイス タイプのカンマ区切りリストを指定します (リストにない型は返しません)。特定のデバイス タイプのセットから挿入されたアイテムのみを返すよう、返却セットをフィルタリングします。このフィルターにはデバイス タイプのカンマ区切りリストが使用されます (1 回の呼び出しで複数のデバイス タイプを問い合わせできます)。取り得る値: 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 の両方のトークンがサポートされています。