BlackList
blacklist.get
ブラックリストに指定しているユーザーの一覧を取得します。
API の定義
| REST Base URI | http://app.mbga-platform.jp/social/api/restful/v2 ( Service ) http://app.sb.mbga-platform.jp/social/api/restful/v2 ( Sandbox ) |
| REST HTTP Method | GET |
| REST URI Fragment | ``` /blacklist/{userId}/{groupId}{-prefix |
| REST Query Parameters | Get-BlackList-Request-Parameters |
| Return Object | BlackList Collection |
認可
| type | permission | description |
|---|---|---|
| ANONYMOUS | false | 未認証でのアクセス |
| SECURITY_TOKEN | false | セキュリティトークンを用いた認証 |
| OAUTH_MOBILE | false | モバイル用で発行された OAuth Token を用いた認証 |
| OAUTH_CONSUMER | true | Consumer Request を用いた認証 |
RESTful API レスポンスコード
| HTTP Status Code | HTTP Status Message | JSON-RPC Error Codes | Meaning |
|---|---|---|---|
| 200 | OK | – | データの取得が成功した場合 |
| 400 | Bad Request | -32700, -32600, -32601, -32602, 400 | クライアント側のリクエストデータが不正です |
| 401 | Unauthorized | 401 | 認証エラーです |
| 403 | Forbidden | 403 | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 | Not Found | 404 | 存在しないリソースです |
| 405 | Method Not Allowed | 405 | その操作が許可されていない場合です |
| 500 | Internal Server Error | -32603 | API サーバー側のエラーです |
| 503 | Service Unavailable | – | 一時的に API が利用不可となっている場合です |
JSON-RPC エラーコード
エラー時の Error オブジェクトの code フィールドに含まれる値です。
| RPC Code | Meaning |
|---|---|
| -32700 (Parse error) | 不正な JSON format です |
| -32600 (Invalid Request) | 不正な JSON-RPC リクエストです |
| -32601 (Method not found) | 存在しないメソッドまたは利用不能なメソッドです |
| -32602 (Invalid params) | 不正な API リクエストパラメータです |
| -32603 (Internal server error) | API サーバー側のエラーです |
| 400 (Bad Request) | 他のエラーに該当しないクライアント側の不正なリクエストです |
| 401 (Unauthorized) | 認証エラーです |
| 403 (Forbidden) | リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です |
| 404 (Not Found) | 存在しないリソースです |
| 405 (Method Not Allowed) | その操作が許可されていない場合です |
データ型
Get-BlackList-Request-Parameters
userId, groupId, personId は URI Template Parameters として指定し、それ以外のパラメータは Query String として指定します。
| Name | Type | Description |
|---|---|---|
| userId | UserId or Array | Required |
| groupId | GroupId | Required '@all' のみ指定可能 |
| personId | UserId or Array | Optional |
| fields | Array | Optional |
ベースとなるデータ型
- Standard-Request-Parameters
- Collection-Request-Parameters
Starndard-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| format | String | Optional 'json' のみ指定可能 |
詳しくは 6.1 Standard Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
Collection-Request-Parameters
サポートしているフィールド一覧は下記になります。
| Name | Type | Description |
|---|---|---|
| count | Number | Optional, 1以上1000以下の整数、デフォルト値は50 |
| startIndex | Number | Optional, 1以上の整数値 |
| sortBy | String | Optional, 'targetId' のみ指定可能 |
| sortOrder | String | Optional, 'ascending' または 'descending' |
詳しくは 6.2 Collection Request Parameters - OpenSocial Core API Server Specification をご参照下さい。
BlackList
| Name | Type | Description |
|---|---|---|
| id | UserId | targetId のユーザーをブラックリストに追加しているユーザー |
| targetId | UserId | id のユーザーにブラックリストに追加されているユーザー |
注意事項
- userId に Mobage で有効なユーザー ID を指定する場合、そのアプリケーションをユーザーがインストールしている必要があります。
- ユーザーがそのアプリケーションをインストールしていない場合、ユーザが存在しない場合はレスポンスコードは 403 が返ります。
サンプルデータ
RESTful API
BlackList に登録しているユーザー一覧を取得する
GET /social/api/restful/v2/blacklist/1234/@all
Host: app.sb.mbga-platform.jp
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"entry" : [
{
"id" : "sb.mbga.jp:1234",
"targetId": "sb.mbga.jp:5678",
},
{
"id" : "sb.mbga.jp:1234",
"targetId": "sb.mbga.jp:6789",
},
],
"startIndex" : 1,
"itemsPerPage" : 50,
"totalResults" : 2
}
二者間でのブラックリストチェック
GET /social/api/restful/v2/blacklist/1234/@all/5678
Host: app.sb.mbga-platform.jp
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"id" : "sb.mbga.jp:1234",
"targetId": "sb.mbga.jp:5678",
}
personId に指定したユーザーをブラックリストに登録していない場合は、404 Not Found が返ります。
GET /social/api/restful/v2/blacklist/1234/@all/9999
Host: app.sb.mbga-platform.jp
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8
{
"Error" : {
"Code" : "404",
"Message" : "Not Found"
}
}
参考資料
OpenSocial Core API Server Specification 1.0
OpenSocial Core Data Specification 1.0
OpenSocial Social API Server Specification 1.0
OpenSocial Social Data Specification 1.0
更新履歴
-
2013/01/22
- 指定ユーザが存在しない場合に関する注意事項を追加
-
2010/10/21
- userId に関する注意事項を追加
-
2010/10/06
- sb.dena.jp -> sb.mbga.jp に修正