POST (/users/{ownerId}/people/xuids)
呼び出し元のユーザー コレクションの XUID を使用してユーザーを取得します。
これらの URI のドメインは social.xboxlive.com です。
解説
POST 操作はどのリソースも変更しないので、何回実行した場合でも得られる結果は同じです。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| ownerId | 文字列 | アクセスするリソースを持つユーザーの ID。 認証済みユーザーと一致する必要があります。 指定できる値は "me"、xuid({xuid})、または gt({gamertag}) です。 |
Authorization
| 種類 | 必須かどうか | 説明 | 存在しない場合の応答 |
|---|---|---|---|
| XUID | はい | 呼び出し元はユーザーの Xbox LIVE ユーザー ID (XUID) を持っています。 | 401 Unauthorized |
必須の要求ヘッダー
| ヘッダー | 説明 |
|---|---|
| 承認 | 文字列。 Xbox LIVE の承認データ。 通常、これは暗号化された XSTS トークンです。 値の例: XBL3.0 x=<userhash>;<token>。 |
| Content-Length | 32 ビット符号なし整数。 要求本文の長さ (バイト単位)。 値の例: 22。 |
| Content-Type | 文字列。 要求本文の MIME タイプ。 これは application/json である必要があります。 |
省略可能な要求ヘッダー
| ヘッダー | 説明 |
|---|---|
| X-RequestedServiceVersion | この要求の送信先である Xbox LIVE サービスのビルド名/番号。 要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。既定値: 1。 |
| Accept | 文字列。 呼び出し元が応答で受け付ける Content-Types。 すべての応答は application/json です。 |
リクエストの本文
必須メンバー
| メンバー | 説明 |
|---|---|
| XuidList | 呼び出し元のユーザー コレクションから取得するユーザーを識別する XUID の配列です。 「XuidList (JSON)」を参照してください。 |
省略可能なメンバー
この要求には省略可能なメンバーはありません。
禁止されたメンバー
その他のすべてのメンバーは要求では使用できません。
サンプル要求
{
"xuids": [
"2533274790395904",
"2533274792986770",
"2533274794866999"
]
}
HTTP ステータス コード
サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。
| コード | 理由 | 説明 |
|---|---|---|
| 200 | OK | メソッドが "取得" のときは成功を表します。 |
| 204 | No Content | メソッドが "追加" または "削除" のときは成功を表します。 |
| 400 | Bad Request | メソッドのパラメーターが不足している、形式が正しくない、またはユーザー ID の形式が正しくありませんでした。 |
| 403 | Forbidden | 承認ヘッダーから XUID クレームを解析できませんでした。 |
必須の応答ヘッダー
| ヘッダー | 型 | 説明 |
|---|---|---|
| Content-Length | 32 ビット符号なし整数 | 応答本文の長さ (バイト単位)。 値の例: 22。 |
| Content-Type | 文字列 | 応答本体の MIME タイプ。 これは常に application/json です。 |
応答の本文
応答の本文は、要求メソッドが "取得" の場合にのみ送信されます。 "追加" または "削除" の場合は応答本文はありません。
"取得" メソッドの呼び出しが成功した場合、サービスは、呼び出し元のユーザー コレクションのユーザーの総数と、呼び出し元のユーザー コレクションを格納する配列を返します。 "追加" および "削除" メソッドの場合は応答は返されません。 「PeopleList (JSON)」を参照してください。
サンプル応答
{
"people": [
{
"xuid": "2603643534573573",
"isFavorite": true,
"isFollowingCaller": false,
"socialNetworks": ["LegacyXboxLive"]
},
{
"xuid": "2603643534573572",
"isFavorite": true,
"isFollowingCaller": false,
"socialNetworks": ["LegacyXboxLive"]
},
{
"xuid": "2603643534573577",
"isFavorite": false,
"isFollowingCaller": false
},
],
"totalCount": 3
}