1.概要

ユーザーが設定してあるブラックリスト情報を取り扱います。

2.オブジェクトフィールド

2.1 BlackList

パラメータ	内容	型
id	禁止リスト所持者のユーザーID	string
blacklistid	禁止リスト対象者のユーザーID	string

3.リクエスト

3.1 エンドポイント

http://gpf-api.[対象ドメイン]/social/blacklist/{uid}

3.2 HTTPメソッド

HTTPメソッド	機能
GET	ブラックリストユーザーの取得
PUT	–
POST	–
DELETE	–

3.3 認証
HTTPヘッダーに以下の値を設定してください。全て必須項目です。

キー	値
Authorization	呼び出しユーザーのsapkeyを指定
GAME_CODE	利用ゲームのGAME_CODE
Hash	SHA1(Authorizaion + GAME_CODE + API_KEY)

3.4 テンプレートパラメータ

uid

パラメータ	内容	備考
@me	呼び出しユーザー	どちらか必須
ユーザーのsapkey	指定したユーザー	どちらか必須

2.5 クエリパラメータ

format

パラメータ	内容	備考
json	“application/json;charset=utf8”	デフォルトでセットされます

count

パラメータ	内容	備考
任意の自然数	最大取得件数

startIndex

パラメータ	内容	備考
任意の自然数	取得するPersonオブジェクトの開始値

4.レスポンス

HTTPメソッド	レスポンスコード	内容
GET	200	データ取得正常終了
GET	400	リクエスト不正
GET	401	認証失敗
POST/PUT/DELETE	403	許可されていないメソッド
GET	500	プラットフォームエラー

X.サンプル

X.1 Authorizationに設定されているユーザーの禁止リスト対象者を全て取得する

【リクエスト】
/social/blacklist/@me
【レスポンス】
{
    "entry": [
        {
            "blacklistid":"1151252574b0572328af9ecf1bccd2cf4bb9c697e674ef1d1a858ffa7f2bd59f",
            "id":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa"
        },
        {
            "blacklistid":"1151252574d7880aa75055bbeb6133787fe498c0ee6246040a842df6d757c96e",
            "id":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa"
        },
        {
            "blacklistid":"115125257407c4a8116ade1dee6df4f99b402f69bad733184c50fe313e100ad3",
            "id":"1151252574130c50684384386c99268003465a46d9c732c0b5baecdaed631dfa"
        }
    ],
    "itemsPerPage":0,
    "startIndex":0,
    "totalResults":3
}

X.2 パラメータで指定したユーザーの禁止リスト対象者を全て取得する

【リクエスト】
/social/blacklist/1151252574b0572328af9ecf1bccd2cf4bb9c697e674ef1d1a858ffa7f2bd59f
【レスポンス】
{
    "entry": [
        {
            "blacklistid":"1151252574e73e3ae285e2ae70152f960c32d6dd55fe3015d7fd01529392fd29",
            "id":"1151252574b0572328af9ecf1bccd2cf4bb9c697e674ef1d1a858ffa7f2bd59f"
        },
        {
            "blacklistid":"1151252574e73e3ae285e2ae70152f960c32d6dd55fe3015d7fd01529392fd29",
            "id":"1151252574b0572328af9ecf1bccd2cf4bb9c697e674ef1d1a858ffa7f2bd59f"
        }
    ],
    "itemsPerPage":0,
    "startIndex":0,
    "totalResults":2
}