次の方法で共有

GET (/users/{ownerId}/people)

  • [アーティクル]

呼び出し元のユーザー コレクションを取得します。 これらの URI のドメインは social.xboxlive.com です。

解説

GET 操作はどのリソースも変更しないので、何回実行した場合でも得られる結果は同じです。

URI パラメーター

パラメーター 型 説明
ownerId 文字列 アクセスするリソースを持つユーザーの ID。 認証済みユーザーと一致する必要があります。 指定できる値は "me"、xuid({xuid})、または gt({gamertag}) です。

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

パラメーター 型 説明
view 文字列 ビューに関連付けられているユーザーを返します。 既定値は "all" です。 有効な値は次のとおりです。
  • All - ユーザーのユーザー リストのすべてのユーザーを返します。 これは既定値です。
  • Favorite - ユーザーのユーザー リストで Favorite 属性を持つすべてのユーザーを返します。
  • LegacyXboxLiveFriends - ユーザーのユーザー リストで、従来の Xbox LIVE フレンドでもあるすべての人を返します。

    • 注: 呼び出し元ユーザーが所有ユーザーと異なる場合、サポートされる値は All だけです。
startIndex 32 ビット符号なし整数 指定したインデックスを開始位置として項目を返します。
maxItems 32 ビット符号なし整数 開始インデックス以降のコレクションから取得するユーザーの最大数です。 maxItems が指定されていない場合、サービスによって既定値が提供され、(最後のページの結果がまだ返されていない場合でも) 返される項目の数が maxItems 未満となる場合があります。

Authorization

種類 必須かどうか 説明 存在しない場合の応答
XUID はい 呼び出し元はユーザーの Xbox LIVE ユーザー ID (XUID) を持っています。 401 Unauthorized

必須の要求ヘッダー

ヘッダー 説明
承認 文字列。 Xbox LIVE の承認データ。 通常、これは暗号化された XSTS トークンです。 値の例: XBL3.0 x=<userhash>;<token>。

省略可能な要求ヘッダー

ヘッダー 説明
X-RequestedServiceVersion この要求の送信先である Xbox LIVE サービスのビルド名/番号。 要求は、ヘッダー、認証トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。既定値: 1。
Accept 文字列。 呼び出し元が応答で受け付ける Content-Types。 すべての応答は application/json です。

リクエストの本文

この要求の本体で送信されるオブジェクトはありません。

HTTP ステータス コード

サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。

コード 理由 説明
200 OK 成功です。
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",
            "isFollowingCaller": false,
            "isFavorite": false
        },
    ],
    "totalCount": 3
}

関連項目

親

/users/{ownerId}/people