community/search.json 概要

コミュニティを検索してコミュニティの詳細情報を出力します。

リクエスト

パラメータ 説明
keyword string 検索したいキーワードを指定します。

レスポンス

フィールド名 説明
id コミュニティのID
name コミュニティの名前
category コミュニティのカテゴリ
community_url コミュニティTOPのURL
community_image_url コミュニティイメージ画像のURL
joining このコミュニティに参加していればtrue, そうでなければfalseを返します。
admin このコミュニティの管理人であればtrue, そうでなければfalseを返します。
sub_admin このコミュニティの副管理人であればtrue, そうでなければfalseを返します。
created_at コミュニティが作成された日付
admin_member コミュニティ管理人のメンバー情報(詳しくは レスポンスの共通仕様 を参照)
member_count コミュニティ参加者の数
public_flag コミュニティの公開範囲
register_policy コミュニティの参加条件

サンプルリクエスト

$ curl http://example.com/api.php/community/search.json?keyword=Q&apiKey=5ad9d5a6a11c5f13ca5901a7c6e1d89ea991dc195666de393a61c808c61d19a5

サンプルレスポンス

{
    "data": [
        {
            "admin": false, 
            "admin_member": {
                "blocking": false, 
                "friend": false, 
                "friends_count": 2, 
                "id": "1", 
                "name": "OpenPNE君", 
                "profile_image": "http://38.openpne.jp/images/no_image.gif", 
                "profile_url": "http://38.openpne.jp/member/1", 
                "screen_name": "OpenPNE君", 
                "self": false, 
                "self_introduction": "よろしくお願いします。"
            }, 
            "category": "公式", 
            "community_image_url": "http://38.openpne.jp/cache/img/png/w48_h48/c_1_b7992883ae255f03c998ddfbf30b9e77b5bc2907_png.png", 
            "community_url": "http://38.openpne.jp/community/1", 
            "created_at": "Fri, 18 May 2012 08:20:28 +0000", 
            "description": "OpenPNE3に関する質問コミュニティです。", 
            "id": "1", 
            "joining": true, 
            "member_count": 39, 
            "name": "Ver3用 Q&A", 
            "public_flag": "public", 
            "register_policy": "open", 
            "sub_admin": false
        }, 
        {
            "admin": false, 
            "admin_member": {
                "blocking": false, 
                "friend": false, 
                "friends_count": 2, 
                "id": "1", 
                "name": "OpenPNE君", 
                "profile_image": "http://38.openpne.jp/images/no_image.gif", 
                "profile_url": "http://38.openpne.jp/member/1", 
                "screen_name": "OpenPNE君", 
                "self": false, 
                "self_introduction": "よろしくお願いします。"
            }, 
            "category": "公式", 
            "community_image_url": "http://38.openpne.jp/cache/img/png/w48_h48/c_2_bd2905af1caf39d56577086832717d3808ba1d3b_png.png", 
            "community_url": "http://38.openpne.jp/community/2", 
            "created_at": "Fri, 18 May 2012 10:12:54 +0000", 
            "description": "OpenPNE2用質問コミュニティです。", 
            "id": "2", 
            "joining": true, 
            "member_count": 39, 
            "name": "Ver2用 Q&A", 
            "public_flag": "public", 
            "register_policy": "open", 
            "sub_admin": false
        }
    ], 
    "status": "success"
}

Heads up! Google Chromeで「JSONView」という拡張をインストールすると、JSONのサンプルレスポンスがさらに見やすくなります。
JSONView をダウンロード