GET (/users/{ownerId}/people/mute)
ユーザーの消音リストを取得します。
解説
ターゲットが指定された場合、この URI は、ユーザーが消音リストに含まれる場合はそのユーザーのみを返し、ユーザーが含まれない場合は空を返します。
URI パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
| ownerId | 文字列 | 必須。 アクセスするリソースを持つユーザーの ID。 指定できる値は "me"、xuid({xuid})、または gt({gamertag}) です。 認証済みユーザーである必要があります。 値の例: xuid(2603643534573581)、gt(SomeGamertag)。 最大サイズ: なし。 |
プライバシー設定がリソースに与える影響
なし。
Authorization
| 使用される承認クレーム | クレーム | 種類 | 必須かどうか | 値の例 |
|---|---|---|---|---|
| Xuid | 64 ビット符号付き整数 | ○ | 1234567890 |
必須の要求ヘッダー
| ヘッダー | 型 | 説明 |
|---|---|---|
| Authorization | 文字列 | HTTP 認証用の認証資格情報。 値の例: Xauth=<authtoken>。 最大サイズ: なし。 |
| X-RequestedServiceVersion | 文字列 | この要求の送信先である Xbox LIVE サービスのビルド名/番号。 要求は、ヘッダー、承認トークン内のクレームなどの有効性が確認された後でのみ、そのサービスにルーティングされます。 値の例: 1、vnext。 最大サイズ: なし。 |
| Accept | 文字列 | 受け入れ可能な Content-Type。 値の例: application/json。 最大サイズ: なし。 |
リクエストの本文
この要求の本体で送信されるオブジェクトはありません。
HTTP ステータス コード
サービスは、このリソースに対してこのメソッドで実行された要求に応答して、このセクションのステータス コードのいずれかを返します。 Xbox Live サービスで使用される標準 HTTP ステータス コードの一覧については、「標準 HTTP ステータス コード」を参照してください。
| コード | 理由 | 説明 |
|---|---|---|
| 200 | OK | 消音リストの要求の成功。 |
| 400 | Bad Request | URI で指定されたターゲット ID が無効です。 |
| 403 | Forbidden | URI で指定された所有者は、認証されたユーザーではありません。 |
| 404 | Not Found | URI で指定された所有者は存在しません。 |
必須の応答ヘッダー
| ヘッダー | 型 | 説明 |
|---|---|---|
| Content-Type | 文字列 | 要求の本文の MIME タイプ。 値の例: application/json |
| Content-Length | 文字列 | 応答で送信されるバイト数。 値の例: 34 |
| Cache-Control | 文字列 | キャッシュ動作を指定するためのサーバーからの正式な要求。 例: no-cache, no-store |
応答の本文
サンプル応答
「UserList」を参照してください。
{
"users":
[
{ "xuid":"12345" },
{ "xuid":"23456" }
]
}