POST /users/xuid(xuid)/lists/PINS//ContainsItems

リスト全体を取得せずに、リストに一連のアイテム (itemId で指定) が含まれているかどうかを判定します。これらの URI のドメインは eplists.xboxlive.com です。

備考
URI パラメーター
クエリ文字列パラメーター
リクエスト本文
HTTP ステータスコード
必須リクエストヘッダー
レスポンス本文

備考

このエンドポイントを使用すると、呼び出し元は指定されたリスト内に 1 つ以上のアイテムが存在するかどうかを、実際にリストを取得して自ら検索することなく判定できます。アイテムのセットは itemId (または provider/providerId の組み合わせ) によって識別され、返されるデータは渡されたデータに、リストに各アイテムが含まれているかどうかを示す true または false の Boolean 値を加えたものです。

URI パラメーター

パラメーター	型	説明
XUID	string	ユーザーの XUID。
listname	string	操作するリストの名前。

クエリ文字列パラメーター

クエリパラメーターはサポートされていません。

リクエスト本文

{
  "Items":
  [{"ItemId":  "ed591a0c-dde3-563f-99af-530278a3c402",
    "ProviderId":  null,
    "Provider": null
  }]
}


    

HTTP ステータスコード

サービスは、このリソースに対するこのメソッドでのリクエストに応じて、このセクション内のいずれかのステータスコードを返します。XBOX Live Services で使用される標準的な 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 がクレームの 1 つとして含まれている必要があります。 | | X-XBL-Contract-Version| どの API バージョンを要求しているかを指定します (正の整数)。Pins はバージョン 2 をサポートします。このヘッダーが欠落しているか、値がサポートされていない場合、サービスはステータス説明に “Unsupported or missing contract version header” を含む 400 - Bad request を返します。 | | Content-Type| リクエスト/レスポンス本文の内容が json か xml かを指定します。サポートされる値は “application/json” と “application/xml” です。| | If-Match| 変更リクエストを行う際に、このヘッダーにはリストの現在のバージョン番号を含める必要があります。変更リクエストは PUT、POST、DELETE 動詞を使用します。“If-Match” ヘッダーのバージョンが現在のリストバージョンと一致しない場合、リクエストは HTTP 412 - precondition failed のリターンコードで拒否されます。(任意) GET でも使用でき、指定されたバージョンが現在のリストバージョンと一致する場合、リストデータはなく HTTP 304 - Not Modified コードが返されます。 |

レスポンス本文

呼び出しが成功すると、アイテムのリストが、各アイテムがリストに含まれているかどうかを指定する Boolean 値とともに返されます。

サンプルレスポンス

{
  "ContainedItems":
  [{"Contained": "true",
    "Item":
   {"ItemId":  "ed591a0c-dde3-563f-99af-530278a3c402",
    "ProviderId": null,
    "Provider": null
   }
  }]
}


      

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

POST /users/xuid(xuid)/lists/PINS/{listname}/ContainsItems

POST /users/xuid(xuid)/lists/PINS//ContainsItems

備考

URI パラメーター

クエリ文字列パラメーター

リクエスト本文

HTTP ステータスコード

必須リクエストヘッダー

レスポンス本文

サンプルレスポンス

関連項目

親

​POST /users/xuid(xuid)/lists/PINS//ContainsItems

​備考

​URI パラメーター

​クエリ文字列パラメーター

​リクエスト本文

​HTTP ステータス コード

​必須リクエスト ヘッダー

​レスポンス本文

​サンプル レスポンス

​関連項目

親

POST /users/xuid(xuid)/lists/PINS//ContainsItems

備考

URI パラメーター

クエリ文字列パラメーター

リクエスト本文

HTTP ステータスコード

必須リクエストヘッダー

レスポンス本文

サンプルレスポンス

関連項目