Blacklist の取得

 

  • 指定ユーザのブラックリストおよびその中に登録されたユーザを取得します。
  • 特定ユーザ(personId)が指定ユーザ(userId)のブラックリストに登録されていれば、それらのユーザの情報を取得します。
  • 特定ユーザが指定ユーザのブラックリストに登録されているかどうを確認する場合にも利用できます。
アプリをインストールしているユーザのみが結果に含まれます。

URI Fragment

/blacklist/{-list|,|userId}/@all
/blacklist/{-list|,|userId}/@all/{-list|,|personId}

パラメータ名

説明

userId

文字列/数値

現在ログインしているユーザを表す @me、またはユーザID

persionId

数値

ユーザのブラックリストに登録されているかを確認したいユーザ ID、下記実例参照

署名方式

  • 2-legged(Trusted モデル)
  • 3-legged(Proxy モデル)

OAuth 認証についてはこちら、リクエストの署名や Authorization ヘッダーの作成についてはこちらを参照して下さい。

HTTP メソッド

GET

リクエストヘッダー

  • Authorization ヘッダーは必須になります。

URL クエリパラメータ

パラメータ名

説明

必須

fields

リスト

取得したいフィールドのカンマ区きりリスト

No

format

文字列

"json" を指定して下さい

No

count

数値

1-1000 の整数値。デフォルトは 50 です

No

sortBy

文字列

"targetId" のみ利用可能

No

sortOrder

文字列

"ascending" または "descending"

No

startIndex

数値

1 以上の整数値

No

リクエスト本文

なし

レスポンスコード

HTTP ステータスコード

HTTP ステータスメッセージ

説明

200

OK

データの取得が成功した場合

400

Bad Request

クライアント側のリクエストデータが不正です

401

Unauthorized

認証エラーです

403

Forbidden

リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です

404

Not Found

存在しないリソースです

500

Internal Server Error

API サーバー側のエラーです

503

Service Unavailable

一時的に API が利用不可となっている場合です

 

注意事項

  • ユーザーがそのアプリケーションをインストールしていない場合、ユーザが存在しない場合はレスポンスコードは 403 が返ります。

レスポンス本文

  • Blacklist 登録状況を表す id-targetid のペア
  • Content-Type: application/json; charset=utf-8

パラメータ名

説明

id

ユーザ ID

下記 targetId を持つユーザを自分のブラックリストに登録したユーザの ID

targetId

ユーザ ID

上記 id を持つユーザのブラックリストに登録されたユーザの ID

実例

ユーザのブラックリストに登録されたユーザ一覧を取得します
Base String
HTTP リクエスト
HTTP レスポンス

 

複数ユーザのブラックリストを一度に取得します
Base String
HTTP リクエスト
HTTP レスポンス

 

指定ユーザはあるユーザのブラックリストに登録されているかどうか確認します
Base String
HTTP リクエスト
HTTP レスポンス

 

一覧ではなく結果が一つだけになる例
Base String
HTTP リクエスト
HTTP レスポンス

PREVIOUS

Blacklist

NEXT

Remote Notification