POST (/users/xuid(xuid)/lists/PINS/)
クエリ文字列パラメーター insertIndex に基づいた位置にアイテムをリストに挿入します。 これらの URI のドメインはeplists.xboxlive.com です。
備考
この呼び出しでは、クエリ文字列パラメーター insertIndex (既定は 0、つまりリストの先頭) に基づいた位置にアイテムをリストに挿入します。リクエスト本文内のすべてのアイテムがその位置に挿入されます。insertIndex が既存のリストのアイテム数より大きい場合、新しいアイテムは末尾に挿入されます。 挿入するアイテムには、機能仕様で示されている必須フィールドが必要です。そうでない場合、HTTP 400 が返されます。同様に、挿入結果によってリストの最大サイズ (リスト タイプごとに定義) を超える場合、HTTP 400 が返され、何も挿入されません。 アイテムをリストの先頭または末尾以外に挿入する場合、リクエストに If-Match:versionNumber ヘッダーを含める必要があります。挿入が先頭または末尾の場合、このヘッダーは任意です。ヘッダーが存在する場合、挿入位置に関係なく検証されます。ヘッダー内の VersionNumber は、リストの現在のバージョン番号です。必須の場合に含まれていない、または現在のリスト バージョン番号と一致しない場合、HTTP 412 (precondition failed) ステータス コードが返され、レスポンス本文には現在のバージョン番号を含むリストの最新メタデータが含まれます。これは、異なるクライアントからの更新が互いに上書きし合うのを防ぐためです。 この呼び出しはべき等ではないことに注意してください。同じデータで繰り返し呼び出すと、複数の挿入が行われる可能性があります。ただし、現在いずれのリストも重複をサポートしていないため、繰り返しの呼び出しは HTTP 400 コードが返される可能性が高いです。URI パラメーター
クエリ文字列パラメーター
| パラメーター| 型| 説明| | --- | --- | --- | --- | --- | --- | | insertIndex| string| 任意。アイテムを挿入する位置を定義します。サポートされる値: 0、正の整数、および “end”。リスト アイテム数より大きいインデックス値は、新しいアイテムをリストの末尾に追加し、リスト内に「空白」スペースを挿入しません。既定値: 0。|認可
この呼び出しでは、Authorization ヘッダーに XSTS SAML トークンが必要です。呼び出し元を識別するために、SAML トークン内に Xuid クレームが存在する必要があります。この値は、呼び出し元が該当するリスト データへのアクセス権を持っているかどうかを判定するために使用されます。リスト自体も Xuid によって識別され、リストの URI に含まれます。これを使用することで、将来的にはリストの共有アクセスをサポートする可能性がありますが、現時点ではこの機能はサポートされていません。現在、ユーザーがアクセスするリストはすべてそのユーザー自身のものであり、共有アクセスはありません。したがって、URI 内の Xuid は SAML クレーム トークン内の Xuid と一致する必要があります。注:
現時点では XBL Auth 2.0 と 3.0 の両方のトークンがサポートされています。