@xuduochoua 2016-12-14T01:52:12.000000Z 字数 31878 阅读 1806

智慧小区接口文档

智慧小区接口文档

返回码说明

{
    code://返回代号：0成功
         //101 密码错误,102 用户不存在,103 手机号重复,104 验证码错误,105缺少必要参数,106数据更新失败
         //201 图片格式错误，202 图片大小错误
    message://提示信息
    data://接口需求的具体数据
}

个人中心接口

1.获取短信验证码（GET）

接口地址:
GET /customer/getcode

eg. http://palmunity.hylapp.com:8080/apis/customer/getcode

请求参数:

参数	数据类型	必填	参数说明
mobile	string		接收短信的手机号码

运行时异常

code	错误原因	返回消息
502	与短信接口通讯异常	短信验证码发送失败
208	手机号码已注册	您的手机号码已注册过，请直接登录哦~

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": "aba25484-c9db-403c-810d-5da308fe48aa" //短信验证码token值
}

DEBUG 短信验证码（GET）

该接口仅用于调试，可以查看尚未发送到手机上的短信验证码！
接口地址:
GET /customer/smscode/debug

eg. http://palmunity.hylapp.com:8080/apis/customer/smscode/debug

请求参数:

参数	数据类型	必填	参数说明
token	string		验证码唯一票据

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": "465124" //短信验证码
}

2.用户注册（POST）

URL: /customer/register

eg. http://palmunity.hylapp.com:8080/apis/customer/register

请求参数:

参数	数据类型	参数说明
mobile	String	手机号
password	String	密码
code	String	验证码
token	String	验证码唯一票据

返回参数:
返回参数data:

{
    id:1,//用户ID
    mobile:"",//用户手机号
    password:"123456",//密码
    name:"Jack",//用户姓名
    communityId:1,//小区ID
    score:0,//积分
    avatar:"",//头像URL
    sex:"0",//性别：0保密，1男，2女
    constellation:"双子座",//星座
    regTime:"2014-07-20 10:00",//注册时间
    registrationId:"abc" //jpush设备码，每次登录更新
}

3.用户登录（POST）

URL: http://palmunity.hylapp.com:8080/apis/customer/login
请求参数:

参数	数据类型	参数说明
mobile	String	手机号
password	String	密码
regId	String	Jpush设备ID

返回参数data:

{
    id:1,//用户ID
    mobile:"",//用户手机号
    password:"123456",//密码
    name:"Jack",//用户姓名
    communityId:1,//小区ID
    score:0,//积分
    avatar:"",//头像URL
    sex:"0",//性别：0保密，1男，2女
    constellation:"双子座",//星座
    regTime:"2014-07-20 10:00",//注册时间
    registrationId:"abc" //jpush设备码，每次登录更新
}

DEBUG 全部住户列表（GET）

该接口仅用于调试，可以查看当前所有住户信息！
接口地址:
GET /customer/debug

eg. http://palmunity.hylapp.com:8080/apis/customer/debug

请求参数: 无

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": []
}

4.修改密码（POST）

URL: http://palmunity.hylapp.com:8080/apis/customer/updatepwd
请求参数:

参数	数据类型	参数说明
id	int	用户ID
pwdold	String	原密码
pwdnew	String	新密码

返回参数: 参考code返回码

5.获取个人资料（GET）

URL: http://palmunity.hylapp.com:8080/apis/customer/detail
请求参数:

参数	数据类型	参数说明
id	int	用户ID

返回参数data:

{
    id:1,//用户ID
    name:"Jack",//用户姓名
    avatar:"http://127.0.0.1/cust/1/avatar/avata.png",//用户头像URL
    sex:1,//性别：0保密，1男，2女
    constellation:"狮子座",//星座
    interestList:[{
                    "name": "打球" //兴趣名称
                }],
    tagList:[{
                "name": "手机控"//标签名称
            }]
}

6.个人中心首页（GET）

URL: http://palmunity.hylapp.com:8080/apis/customer/index
请求参数:

参数	数据类型	参数说明
id	int	用户ID

返回参数data:

{
    id:1,//用户ID
    name:"Jack",//用户姓名
    avatar:"http://127.0.0.1/cust/1/avatar/avata.png",//用户头像
    score:0,//积分
    signable:true,//是否可签到
    replyCount:0,//"回复我的"未读数量
    comunityId:1,//小区ID
    comunityName:"万达城"//小区名称
}

7.完善个人信息（POST）

URL: http://palmunity.hylapp.com:8080/apis/customer/update

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~

请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
name	String	姓名
sex	int	性别：0保密，1男，2女
constellation	String	星座
avatarImg	MultipartFile	头像
interests	String	兴趣。多个兴趣用英文逗号`(,)`分隔
tags	String	标签。多个标签用英文逗号`(,)`分隔

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null
}

8.选择小区接口（POST）

接口地址:
POST /customer/changeCommunity

请求参数:

参数	数据类型	参数说明
principal	int	当前操作人
district	string	行政区域
city	string	所在城市
community	string	小区名称

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": 101 //小区ID
}

9. 查询是否可签到

接口地址:
GET /customer/dailysign/{principal}

eg. http://palmunity.hylapp.com:8080/apis/customer/dailysign/1

路径参数：
principal int 当前操作人ID

请求参数: 无

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": true  //今日是否可签到 true--可签到 false--不可签到
}

10. 签到接口

接口地址:
POST /customer/dailysign/{principal}

路径参数：
principal int 当前操作人ID

请求参数: 无

运行时异常

code	错误原因	返回消息
208	重复签到	您今天已经签到过，不能再重复签到哦~

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

11.忘记密码（POST）

URL: /customer/forgetpwd

eg. http://palmunity.hylapp.com:8080/apis/customer/forgetpwd

请求参数:

参数	数据类型	参数说明
mobile	String	手机号
password	String	密码
code	String	验证码
token	String	验证码唯一票据

返回参数:

{
    id:1,//用户ID
    name:"Jack",//用户姓名
    avatar:"http://127.0.0.1/cust/1/avatar/avata.png",//用户头像
    score:0,//积分
    signable:true,//是否可签到
    replyCount:0,//"回复我的"未读数量
    comunityId:1,//小区ID
    comunityName:"万达城"//小区名称
}

个人消息接口(GET)

URL:http://127.0.0.1:8080/palmcommunity-mobile/trends/message
请求参数:

参数	数据类型	参数说明
start	int	信息列表起始页(默认为0)
size	int	每页显示数量(默认为10)
customerId	int	用户ID

响应参数data:

{   
    typeId:4,                                   //消息类型
                                                    1:赞了我的消息/赞了我;       
                                                    2:给我留言的消息/给我留言;
                                                    3:直接回复我动态的消息/回复我    
                                                    4:回复了我评论的消息/回复我
                                                    5:留言板中回复我的消息/回复我
    customerAvatar:: "http://www.hylapp.com:8084/console/img/avatar/v9.png",    //发消息人头像                      
    customerName:"admin",                       //发消息人姓名
    catalog:0,                                  //消息分类    
                                                    1：心情消息 2：随手拍 3：留言消息
    messageId:3,                                    //原始消息ID
    trendsContent:"今天天气不错",                 //初始消息内容
                                                    null:无初始消息；其他就是初始信息内容
    replyContent:"那一块出去玩吧",                //初始消息内容
                                                    null:表示点赞；其他就是对原消息的回复内容
    createTime:"2014-07-19 23:09",              //消息创建时间
}

随手记相关接口

1.随手记首页（GET）

URL： GET /trends/index

eg. http://palmunity.hylapp.com:8080/apis/trends/index?targetCustomerId=7&loginCustomerId=7

请求参数：

参数	数据类型	参数说明
targetCustomerId	int	目标用户ID
loginCustomerId	int	登录用户ID
start	int	查询开始项，如不填默认为0
size	int	查询条数，如不填默认为10

返回参数data:

{
    targetUserInfo:{
            id:1,//用户ID
            name:"jack",//用户名
            avatar:"http://127.0.0.1/...",//用户头像URL
            sex:1,//性别：0保密，1男2女
            unReadMessage:true,//如果访问用户与被访问用户不一致则为null不显示message图标,否则true有未读消息false没有未读消息
            score:0//积分
        },//如果start=0则返回目标用户的用户信息否则为null
    list:[{
            trendsId:14,//动态ID
            customerName:"Jack",//客户姓名
            avatar:"http://127.0.0.1/..",//头像URL
            content:"今天心情很好",//动态内容
            createTime:"2014-07-23 19:06",//动态创建时间
            gallerys:[{
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-md.png", //小图片
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-lg.png"//大图片
            },
            {
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-md.png",
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-lg.png"
            }],
            type:1,//动态类型：1心情2随手拍
            forkable:true,//是否可赞
            forks:0,//所获赞数
            replys:0//所获回复数
        }]//随手拍动态列表
}

2.心情列表（GET）

URL： GET /trends/mood/list

eg. http://palmunity.hylapp.com:8080/apis/trends/mood/list?targetCustomerId=7&loginCustomerId=7

请求参数：

参数	数据类型	参数说明
targetCustomerId	int	目标用户ID
loginCustomerId	int	登录用户ID
start	int	查询开始项，如不填默认为0
size	int	查询条数，如不填默认为10

返回参数data:

{
    iconFlag:true,//右上角写心情图标是否显示，true显示false不显示
    moodList:[{
            trendsId:14,//动态ID
            customerName:"Jack",//客户姓名
            avatar:"http://127.0.0.1/..",//头像URL
            content:"今天心情很好",//动态内容
            createTime:"2014-07-23 19:06",//动态创建时间
            gallerys:[{  //相片URL数组
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-md.png", //小图片
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-lg.png"//大图片
            },
            {
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-md.png",
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-lg.png"
            }],
            type:2,//动态类型：1心情2随手拍
            forkable:true,//是否可赞
            forks:0,//所获赞数
            replys:0//所获回复数
        }]//心情列表
}

3.新建随手记动态（POST）

URL： http://127.0.0.1/trends/create
请求参数：

参数	数据类型	参数说明
loginCustomerId	int	登录用户ID
content	String	动态内容，如果为随手拍则为空
type	int	动态类型：1心情2随手拍
photo0	MultipartFile	上传的照片
photo1	MultipartFile	上传的照片
photo2	MultipartFile	上传的照片
photo3	MultipartFile	上传的照片
photo4	MultipartFile	上传的照片
photo5	MultipartFile	上传的照片
photo6	MultipartFile	上传的照片
photo7	MultipartFile	上传的照片
photo8	MultipartFile	上传的照片
photo9	MultipartFile	上传的照片
remark0	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark1	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark2	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark3	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark4	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark5	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark6	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark7	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark8	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应
remark9	String数组	图片描述，如果为心情则可为空，如果为随手怕remarks的数量必须与photos的数量一致并一一对应

返回参数data: 参考code返回值

4.删除随手记动态（POST）

URL： http://127.0.0.1/trends/delete
请求参数：

参数	数据类型	参数说明
trendsId	int	动态ID

返回参数data: 参考code返回值

5.对动态进行评论（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/reply/create

请求参数:

参数	数据类型	参数说明
trendsId	int	动态ID
content	String	评论内容
loginCustomerId	int	评论者ID

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~
404	动态ID不存在	很抱歉，您正在查看的动态已删除，请刷新页面后重试！~

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": 121 //评论ID
}

6.删除评论及评论下@回复（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/reply/delete

请求参数：

参数	数据类型	参数说明
replyId	int	评论ID

返回参数data: 参考code返回值

7.在动态下的评论中发表@信息（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/replyat/create

请求参数:

参数	数据类型	参数说明
trendsId	int	动态ID
content	String	评论内容
loginCustomerId	int	评论者ID
replyAtCustomerId	int	@对象ID

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~
404	动态ID不存在	很抱歉，您正在查看的动态已删除，请刷新页面后重试！~

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": 131 //评论ID
}

8.删除@记录（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/replyat/create
请求参数：

参数	数据类型	参数说明
replyAtId	int	@记录ID

返回参数data: 参考code返回值

9.赞/取消赞（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/fork
请求参数：

参数	数据类型	参数说明
loginCustomerId	int	当前登陆用户ID
trendsId	int	动态ID

返回参数data:

{data:addSuccess//addSuccess点赞成功，cancelSuccess取消赞成功}

10.随手拍列表（GET）

URL： http://palmunity.hylapp.com:8080/apis/trends/gallery/list
请求参数：

参数	数据类型	参数说明
targetCustomerId	int	目标用户ID
loginCustomerId	int	登录用户ID
start	int	查询开始项，如不填默认为0
size	int	查询条数，如不填默认为10

返回参数data:

{
    iconFlag:true,//右上角新建随手拍图标是否显示，true显示false不显示
    galleryList:[{
            trendsId:14,//动态ID
            createTime:"2014-07-23 19:06",//动态创建时间
            imgPath:"http://127.0.0.1/...",//首张图片URL地址
            count:2//该条动态上传照片的张数
        }]//gallery列表
}

11.删除单张照片（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/gallery/delete
请求参数：

参数	数据类型	参数说明
galleryId	int	照片ID

返回参数data: 参考code返回值（注：如果单条随手拍中的照片被删完，则会删除随手拍记录）

12.查询随手记动态详情（GET）

URL： http://palmunity.hylapp.com:8080/apis/trends/detail
请求参数：

参数	数据类型	参数说明
targetCustomerId	int	目标用户ID
loginCustomerId	int	登录用户ID
start	int	查询开始项，如不填默认为0
size	int	查询条数，如不填默认为10

返回参数data:

{
    //注：start=0则返回的列表中第一条记录为随手记动态的详情，其他记录为评论列表。
    //如果start>0则返回的全部是评论列表
    /**动态详情JSON**/
    {
        trendsId:14,//动态ID
        trendsType:1,//动态类型：1心情，2随手拍
        trendsCustomerId:1//动态创建人ID
        trendsCustomerAvatar:"http://127.0.0.1/...",//动态创建人头像URL
        trendsCustomerName:"Jack",//动态创建人姓名
        trendsContent:"今天心情不错",//动态内容
        forkAble: true,//该动态是否可点赞
        delAble: true,//该动态是否可删除
        forks: 0,//该动态有多少赞
        replys: 3,//该动态有多少回复
        createTime: "2014-07-23 17:59:03.0",//动态创建时间
        galleryList: [{
                galleryId: 31,//照片ID
                imgPath:"http://127.0.0.1/...",//照片URL
                imageLarger : ""http://www.hylapp.com:8084/console/img/avatar/v5.png",
                remark: "描述信息..."//照片描述
                }]//照片列表
    }
    /**评论列表JSON**/
    {
        replyId: 8,//评论ID
        replyCustomerId: 2,//评论人ID
        replyCustomerAvatar: "http://127.0.0.1/..",//评论人头像URL
        replyCustomerName: "Mark",//评论人姓名
        content: "我是2，我对1刚发表的心情评论了",//评论内容
        createTime: "2014-07-23 17:59:42.0",//评论时间
        delAble: true,//该评论是否可删除
        replyAtList: [{
                replyAtId: 1,//@回复的ID
                replyId: 8,//@回复所属评论的ID
                atMasterId: 1,//@发起人的ID
                atMasterName: "Jack",//@发起人姓名
                atTargetName: "Mark",//@对象名字
                content: "我是1，谢谢2的评论",//@内容
                createTime: "2014-07-23 18:00",//@时间
                delAble: true//该@记录是否可删除
            }]//该评论下@回复列表
    }
}

13.新增留言（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/board/create
请求参数：

参数	数据类型	参数说明
loginCustomerId	int	登录用户ID即留言人ID
masterId	int	留言板主人ID
content	String	留言内容

返回参数data: 参考code返回值

14.删除留言及留言下的回复列表（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/board/delete
请求参数：

参数	数据类型	参数说明
boardId	int	留言ID

返回参数data: 参考code返回值

15.在留言下新增回复（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/board/reply/create
请求参数：

参数	数据类型	参数说明
loginCustomerId	int	登录用户ID即回复人ID
boardId	int	留言ID，对哪条留言进行回复
content	String	回复内容

返回参数data:

{
    13//返回该新增回复的ID
}

16.删除留言下某条具体的回复（POST）

URL： http://palmunity.hylapp.com:8080/apis/trends/board/reply/delete
请求参数：

参数	数据类型	参数说明
boardReplyId	int	留言下某条具体回复的ID

返回参数data: 参考code返回值

17.查询某人的留言列表（GET）

{
    id: 4,//留言ID
    boardCustomerName: "lucy",//留言发起人姓名
    boardCustomerAvatar:"http://127.0.0.1/...",//头像URL..
    boardContent: "我是3，我对1留言了",//留言内容
    boardCreateTime: "2014-07-23 14:28",//留言时间
    delAble: true,//该留言是否可删除
    replyAble: true,//该留言是否可回复
    replyList: [{
            id: 7,//留言下回复的ID
            content: "我是1，谢谢4对我的留言",//留言下回复的内容
            createTime: "2014-07-23 14:28",//留言下回复的时间
            name: "jack",//留言下回复人的姓名
            delAble: false//该留言下的回复是否可删除
            }]//留言下的回复列表
}

18.查询留言详情（GET）

URL： http://palmunity.hylapp.com:8080/apis/trends/board/detail
请求参数：

参数	数据类型	参数说明
boardId	int	留言ID
loginCustomerId	int	登录用户ID

返回参数data:

{
    id: 4,//留言ID
    boardCustomerName: "lucy",//留言发起人姓名
    boardContent: "我是3，我对1留言了",//留言内容
    boardCreateTime: "2014-07-23 14:28",//留言时间
    delAble: true,//该留言是否可删除
    replyAble: true,//该留言是否可回复
    replyList: [{
            id: 7,//留言下回复的ID
            content: "我是1，谢谢4对我的留言",//留言下回复的内容
            createTime: "2014-07-23 14:28",//留言下回复的时间
            name: "jack",//留言下回复人的姓名
            delAble: false//该留言下的回复是否可删除
            }]//留言下的回复列表
}

周边服务接口

1.获取店铺种类(GET)

URL:http://palmunity.hylapp.com:8080/apis/surround/shopCategory
请求参数:无
响应参数data:

{   
    {
        id:1,                   //店铺种类id
        name:"果蔬"             //店铺名称
    },
    {
        id:2
        name:"外卖"
    }
}

2.获取店铺列表(GET)

URL:http://palmunity.hylapp.com:8080/apis/surround/shop
请求参数:

参数	数据类型	参数说明
start	int	分页起始页(可选，默认为0)
size	int	每页显示数量(可选，默认为10)
category	String	选择显示的店铺种类ID拼接成的字符串，用逗号连接，如“1,2,3,4”
communityId	int	社区ID

响应参数data:

{   
    id:1                                                                //店铺种类ID
    name:"老王水果店"                                                    //店铺种类名称
    image:"http://127.0.0.1:8080/palmcommunity-mobile/src/test"        //店铺图片url
    categoryName:"果蔬"                                                 //店铺种类名称
    location:"合肥市"                                                   //店铺地址
    popularity:16                                                      //店铺人气
}

3.店铺详情(GET)

URL:http://palmunity.hylapp.com:8080/apis/surround/shopDetail
请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
shopId	int	店铺ID

响应参数data:

{   
    id:  1                                                              //店铺种类ID
    name:"老王水果店"                                                    //店铺种类名称
    image:"http://127.0.0.1:8080/palmcommunity-mobile/src/test"         //店铺图片url
    businessTime:"8:20 -- 21:00"                                        //营业时间
    scope:"水果蔬菜"                                                     //店铺经营范围
    location:"合肥市"                                                    //店铺地址
    longitude:"117.241179"                                               //店铺经度(String)
    latitude:"31.820578"                                                 //店铺纬度(String)
    tel:"0551-35828555"                                                 //店铺固定电话
    mobile:"138466483654"                                               //店铺手机电话
    promotion:""                                                        //促销信息
    popularity:16                                                       //人气
    favority:true                                                       //是否已被收藏
                                                                            fasle:未被该用户收藏      
                                                                            true:已被该用户收藏
}

4.增加积分(POST)

URL:http://palmunity.hylapp.com:8080/apis/surround/shopPopularity
请求参数:

参数	数据类型	参数说明
id	int	店铺ID

响应参数data:参考code返回码

5.增加店铺/帖子收藏(POST)

URL:http://palmunity.hylapp.com:8080/apis/customer/favorite/add
请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
type	int	收藏类型：1-店铺，2-帖子
targetId	int	店铺/帖子ID

响应参数data:参考code返回码

6.取消店铺/帖子收藏(POST)

URL:http://palmunity.hylapp.com:8080/apis/customer/favorite/delete
请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
type	int	收藏类型：1-店铺，2-帖子
targetId	int	店铺/帖子ID

响应参数data:参考code返回码

系统接口

1.意见反馈(POST)

URL:http://palmunity.hylapp.com:8080/apis/feedback/create
请求参数:

参数	数据类型	参数说明
content	String	建议内容
id	int	用户ID（可选）

响应参数data:参考code返回码

2.版本更新(GET)

URL:http://palmunity.hylapp.com:8080/apis/version
请求参数:

参数	数据类型	参数说明
code	int	版本号

响应参数data:

{   
    version:"10.0.0.3"                                                                          //版本号
    log:"更新日志：....（略）"                                                                    //更新日志
    downloadurl:"http://gdown.baidu.com/data/wisegame/bf076742152b3b8e/baiduditu_546.apk"       //下载地址
    downloadTimes:5                                                                             //下载次数
}

3.系统支持(GET)

URL:http://palmunity.hylapp.com:8080/apis/system/support
请求参数: 无
响应参数data:返回系统支持信息

我的收藏接口

1.我的店铺收藏(GET)

URL:http://palmunity.hylapp.com:8080/apis/customer/favorite/queryFavoriteShop
请求参数:

参数	数据类型	参数说明
start	int	信息列表起始页(默认为0)
size	int	每页显示数量(默认为10)
customerId	int	用户ID

响应参数data:

{   
    id:1                                                                //店铺种类ID
    name:"老王水果店"                                                    //店铺种类名称
    image:"http://127.0.0.1:8080/palmcommunity-mobile/src/test"        //店铺图片url
    categoryName:"果蔬"                                                 //店铺种类名称
    location:"合肥市"                                                   //店铺地址
    popularity:16                                                      //店铺人气
}

2.我的帖子收藏(GET)

URL:http://palmunity.hylapp.com:8080/apis/customer/favorite/queryFavoriteTopic
请求参数:

参数	数据类型	参数说明
start	int	信息列表起始页(默认为0)
size	int	每页显示数量(默认为10)
customerId	int	用户ID

响应参数data:

{   
    id:1,                                                                       //帖子ID
    title:"转让全新格力电风扇一台",                                                //帖子标题
    customerId:1,                                                               //发帖人ID
    customerName: "朱先龙",                                                      //发帖人昵称
    customerAvatar: "http://www.hylapp.com:8084/console/img/avatar/v5.png",     //发帖人头像
    communityName: "金江苑",                                                     //所属社区名称
    tag: "转让",                                                                 //帖子标签
    image: [{  //相片URL数组
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-md.png", //小图片
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-lg.png"//大图片
            },
            {
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-md.png",
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-lg.png"
            }],          
    createTime: "2014-07-23 09:38",                                             //发帖时间
    replys:2                                                                    //被回复次数
}

城市列表接口

1.获取城市列表（GET）

URL： http://palmunity.hylapp.com:8080/apis/city
请求参数: 无
返回参数data:

{
    id:1,//城市ID
    name:"合肥"//城市名
}

小区接口

1.获取小区列表（GET）

URL: http://palmunity.hylapp.com:8080/apis/community
请求参数:

参数	数据类型	参数说明
name	String	城市名

返回参数data:

{
    name:"金江苑"//小区名
}

2.获取附近小区列表（GET）

URL: http://palmunity.hylapp.com:8080/apis/nearbyCommunity
请求参数:

参数	数据类型	参数说明
name	String	城市名
longitude	double	经度
latitude	double	纬度

返回参数data:

{
    name:"金江苑"//小区名
}

社区接口

1.业主委员会列表（GET）

URL: http://palmunity.hylapp.com:8080/apis/estate/boss
请求参数:

参数	数据类型	参数说明
moduleId	int	模块ID

返回参数data:

{
    name:"洪七",//姓名
    position:"主任",//职位
    image:"http://127.0.0.1/..."//URL地址
}

2.文字列表（GET）

URL: http://palmunity.hylapp.com:8080/apis/estateText
请求参数:

参数	数据类型	参数说明
moduleId	int	模块ID
start	int	起始页默认为0
size	int	查询数量默认为10

返回参数data:

{
    id:1,//文字ID
    title:"今天9点停水",//标题
    createTime:"2014-7-24 6:00"//创建时间
}

3.文字列表详情（GET）

URL: http://palmunity.hylapp.com:8080/apis/estateContent
请求参数:

参数	数据类型	参数说明
id	int	文字列表ID

返回参数data:

{
    title:"今天9点停水",//标题
    createTime:"2014-7-24 6:00",//创建时间
    content:"今天9点停水，请大家做好准备..."//详细内容
}

4.意见反馈（POST）

URL: http://palmunity.hylapp.com:8080/apis/estate/feedback
请求参数:

参数	数据类型	参数说明
moduleId	int	模块ID
customerId	int	用户ID
content	String	反馈内容

返回参数data: 参考code返回值

5.社区相册列表（GET）

URL: http://palmunity.hylapp.com:8080/apis/estate/gallery
请求参数:

参数	数据类型	参数说明
moduleId	int	模块ID

返回参数data:

{
    id:1,//文字ID
    title:"小区大门",//标题
    image:"http://127.0.0.1/..."//大图片URL地址
    imageThumbnail:"http://127.0.0.1/..."//小图片URL地址
}

6. 社区模块列表(GET)

接口地址:
/estate

eg. http://palmunity.hylapp.com:8080/apis/estate?community=1

请求参数:

参数	数据类型	必填	参数说明
community	int		当前操作人小区ID

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {
        "lastNotice": { //小区最新通知，没有通知时为null
            "id": 1,    //通知ID
            "title": "小区7月9日13:00-18:00停水！"  //通知标题
        },
        "group": [  //模块分组
            {
                "category": "物业中心", //分组名
                "module": [  //模块列表
                    {
                        "id": 1,  //模块ID
                        "name": "物业公告",  //模块名称
                        "icon": null,  //模块图标
                        "style": 1     //风格. 1-文字列表 2-相册 3-业主委员会 4-投诉建议
                    },
                    {
                        "id": 2,
                        "name": "社区活动",
                        "icon": null,
                        "style": 1
                    },
                    {
                        "id": 3,
                        "name": "魅力小区",
                        "icon": null,
                        "style": 2
                    },
                    {
                        "id": 4,
                        "name": "投诉建议",
                        "icon": null,
                        "style": 4
                    }
                ]
            },
            {
                "category": "业主之家",
                "module": [
                    {
                        "id": 5,
                        "name": "业主公告",
                        "icon": null,
                        "style": 1
                    },
                    {
                        "id": 6,
                        "name": "业主委员会",
                        "icon": null,
                        "style": 3
                    },
                    {
                        "id": 7,
                        "name": "关爱活动",
                        "icon": null,
                        "style": 1
                    },
                    {
                        "id": 8,
                        "name": "老年风采",
                        "icon": null,
                        "style": 2
                    }
                ]
            }
        ]
    }
}

左邻右里模块接口

1.小伙伴空间首页（GET）

URL: http://palmunity.hylapp.com:8080/apis/customer/friendSpace
请求参数:

参数	数据类型	参数说明
id	int	用户ID

返回参数data:

{
    "code": 0, //0-表示接口调用成功
    "message": null,
    "data": {
        "name": "dfgsdfgdsfgdsgf",  //住户昵称
        "score": 1, //住户积分
        "avatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png",//住户头像
        "sex": "男",//住户性别
        "constellation": "射手座", //住户星座
        "tagName": "宅男 技术", //住户标签
        "interestList": "读书 运动", //住户兴趣
        "communityName": "常青花园"
    }
}

2.小伙伴列表（GET）

URL: http://palmunity.hylapp.com:8080/apis/customer/friends
请求参数:

参数	数据类型	参数说明
communityId	int	小区ID
keyword	String	查询关键字
start	int	起始页默认为0
size	int	查询数量默认为10

返回参数data:

{
    "code": 0,
    "message": null,
    "data": [
        {
            "id": 3,
            "name": "Mary",
            "score": 0,
            "avatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png",
            "tagName": null
        },
        {
            "id": 2,
            "name": "admin",
            "score": 0,
            "avatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png",
            "tagName": null
        }
    ]
}

3.邻里圈动态（GET）

URL: /customer/neighbours

eg. http://palmunity.hylapp.com:8080/apis/customer/neighbours?principal=1&communityId=24

请求参数:

参数	数据类型	参数说明
principal	int	当前登录用户ID
communityId	int	小区ID
start	int	分页参数——起始位置
size	int	分页参数——分页大小

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~

返回参数data:

{
    id:1,//动态ID
    customerId:1,//用户ID
    name:"朱先龙",//用户昵称
    avatar:"http://127.0.0.1/...",//URL地址
    content:"好开森",//心情内容
    catalog:1//动态分类：1心情，2随手拍
    createTime:"2014-7-24 7:30",//创建时间
    gallerys:[{  //相片URL数组
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-md.png", //小图片
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-lg.png"//大图片
            },
            {
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-md.png",
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-lg.png"
            }],
    forks:3,//获赞数量
    replys:3,//评论数量
}

生活帮手（论坛）

本篇文档使用论坛代替生活帮手。

论坛版块列表

接口地址:
GET /bbs

eg. http://palmunity.hylapp.com:8080/apis/bbs

请求参数: 无
响应结果:

{
    "code": 0,    //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": [
        {
            "id": 1,  //版块ID.
            "name": "跳蚤街", //版块名称
            "icon": "http://y1.ifengimg.com/tech_spider/dci_2012/07/2a0e00b47831990433bcb5ce2e9e544f.jpg"  //版块图标
        },
        ...
    ]
}

版块标签（分类）列表

接口地址:
GET /bbs/tag

eg. http://palmunity.hylapp.com:8080/apis/bbs/tag?section=2

请求参数:

参数	数据类型	必填	参数说明
section	int		版块ID

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": [
        {
            "id": 1,    //标签ID
            "name": "转让"  //标签名称
        },
        {
            "id": 2,
            "name": "求购"
        }
    ]
}

主题帖子列表

接口地址:
GET /bbs/topic

eg. http://palmunity.hylapp.com:8080/apis/bbs/topic?section=1

请求参数:

参数	数据类型	参数说明
community	int	小区ID，不传入此参数时返回所有小区的帖子
section	int	版块ID
tag	string	标签ID. 选中多个标签时，用英文逗号`(,)` 分隔。
start	int	分页参数——起始位置
size	int	分页参数——分页

响应结果:

{
    "code": 0,    //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": [
        {
            "id": 2,         //帖子ID
            "sectionId": 0,  //版块ID
            "communityId": 0,  //小区ID
            "customerId": 1,   //发帖人ID
            "customerName": "朱先龙",  //发帖人昵称
            "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png",  //发帖人图像
            "tag": "求购",     //帖子标签（分类）
            "title": "求购二手电风扇一台。",  //帖子标题
            "thumbnails": [{  //相片URL数组
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-md.png", //小图片
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-lg.png"//大图片
            },
            {
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-md.png",
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-lg.png"
            }],
            "createTime": "2014-07-24 17:35",  //发帖时间
            "replys": 1        //回复数量
        },
        {
            "id": 1,
            "sectionId": 0,
            "communityId": 0,
            "customerId": 1,
            "customerName": "朱先龙",
            "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png",
            "tag": "转让",
            "title": "转让全新格力电风扇一台。",
            "image": [
                "http://img0.pchouse.com.cn/pchouse/1107/01/103729_image001.jpg",
                "http://img0.pchouse.com.cn/pchouse/1107/01/103729_image002.jpg",
                "http://img0.pchouse.com.cn/pchouse/1107/01/103729_image003.jpg"
            ],
            "createTime": "2014-07-24 17:35",
            "replys": 2
        }
    ]
}

帖子详情（楼层列表）

接口地址:
GET /bbs/topic/{id}

eg. http://palmunity.hylapp.com:8080/apis/bbs/topic/1?principal=1

路径参数：
id int 帖子ID.

请求参数:

参数	数据类型	参数说明
principal	int	当前操作人
start	int	分页参数——起始位置
size	int	分页参数——分页

运行时异常

code	错误原因	返回消息
404	传入的帖子ID不存在	很抱歉，您正在查看的帖子已删除，请刷新页面后重试！

响应结果:

{
    "code": 0,      //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": [
        {           //这是一楼（主题帖子），数据结构与其他楼层不一样
            "id": 1,    //帖子ID
            "sectionId": 1,  //所属版块ID
            "communityId": 1,  //所属小区ID
            "customerId": 1,   //楼主ID
            "customerName": "朱先龙",  //楼主昵称
            "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png", //楼主头像
            "tag": "转让", //帖子标签（分类）
            "title": "转让全新格力电风扇一台。", //帖子标题
            "thumbnails": [{  //相片URL数组
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-md.png", //小图片
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-lg.png"//大图片
            },
            {
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-md.png",
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-lg.png"
            }],
            "createTime": "2014-07-24 17:35",  //发帖时间
            "replys": 2,    //回复数量
            "removable": false,  //是否允许删除 true-表示当前用户可以删除该帖子
            "favored": false,  //是否已收藏该帖子
            "content": "充话费送的，全新转让！",  //帖子内容
            "fields": [  //一楼特殊字段
                {
                    "key": "价格",
                    "value": 28
                },
                {
                    "key": "新旧",
                    "value": "全新"
                },
                {
                    "key": "分类",
                    "value": "数码产品"
                }
            ]
        },
        {  //这是二楼（沙发），二楼及已下楼层数据接口一样
            "id": 1,  //回复ID
            "sectionId": 1,  //所属版块
            "topicId": 1,    //主题ID，即一楼帖子ID
            "topicCustomerId": 1, //楼主ID
            "communityId": 1, //所属小区
            "customerId": 2,  //回帖人ID
            "customerName": "admin", //回帖人昵称
            "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v9.png", //回帖人图像
            "content": "可以便宜点吗？", //回帖内容
            "createTime": "2014-7-24 17:35", //回帖时间
            "removable": false, //是否允许删除 true-表示当前用户可以删除该帖子
            "replies": [ //对回复的评论
                {  //第一条评论
                    "id": 1,  //评论ID
                    "sectionId": 1, //所属版块
                    "topicId": 1, //主题帖ID
                    "topicCustomerId": 1,//楼主ID
                    "customerId": 1, //评论人
                    "customerName": "朱先龙", //评论人ID
                    "replyId": 1, //所在回复贴ID
                    "at": 2, //评论对象ID（被＠的住户ID）
                    "atName": "admin", //评论对象昵称（被＠的住户昵称）
                    "content": "已经是最低价了哦", //评论内容
                    "removable": true //是否允许删除
                },
                {//第二条评论
                    "id": 2,
                    "sectionId": 1,
                    "topicId": 1,
                    "topicCustomerId": 0,
                    "customerId": 2,
                    "customerName": "admin",
                    "replyId": 1,
                    "at": 1,
                    "atName": "朱先龙",
                    "content": "好吧，谢谢了",
                    "removable": true
                },
                ...
            ]
        },
        ...
    ]
}

请求发主题帖

调用此接口用来获取主题帖的一些特殊字段。

接口地址:
GET /bbs/topic/new

eg. http://palmunity.hylapp.com:8080/apis/bbs/topic/new?section=2

请求参数:

参数	数据类型	必填	参数说明
section	int		版块ID

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {
        "tags": [  //标签列表
            {
                "id": 1,
                "name": "转让"
            },
            {
                "id": 2,
                "name": "求购"
            }
        ],
        "fields": [  //特殊字段定义
            {
                "name": "价格",  //字段显示名称
                "code": "price",//字段代码. 用于提交发帖数据时的参数名
                "type": "numeric",//字段类型.
                "precision": 6, //字段精度（长度）
                "scale": 1, //字段小数点位数
                "options": [//字段可选值
                    {
                        "label": "面议",   //可选值显示名称
                        "value": "negotiable"  //可选值实际值
                    }
                ],
                "value": null //字段默认值
            },
            {
                "name": "新旧",
                "code": "naod",
                "type": "varchar",
                "precision": 10,
                "scale": 0,
                "options": [ ],
                "value": null
            },
            {
                "name": "分类",
                "code": "catalog",
                "type": "dictionary",
                "precision": 0,
                "scale": 0,
                "options": [
                    {
                        "label": "家居日用",
                        "value": "1"
                    },
                    {
                        "label": "服装鞋帽",
                        "value": "2"
                    },
                    {
                        "label": "数码产品",
                        "value": "3"
                    },
                    {
                        "label": "卡票券",
                        "value": "4"
                    },
                    {
                        "label": "服装鞋帽",
                        "value": "5"
                    },
                    {
                        "label": "其他",
                        "value": "6"
                    }
                ],
                "value": "3"
            }
        ]
    }
}

特殊字段定义

key	类型	说明
name	string	字段显示名称
code	string	字段代码。在提交发帖时，特殊字段也需要加到参数中，此时的code即为参数名。
type	string	字段类型. 目前支持的类型有：`numeric,varchar,date,datetime,time,dictionary`。其中`dictionary`表示字典型字段，客户端应使用`select`方式来选择值，可选值参考`option`属性。
precision	int	字段精度
scale	int	字段小数点位数
options	array	字段值选项. 若该数组不为空，客户端应展现按钮或选择框。在提交表单时，该字段应提交选中的选项的`value`属性而非用户填入的文本。
options.label	string	选项显示名称
options.value	string	选项值
value	string	字段默认值.

发主题贴

接口地址:
POST /bbs/topic/new

请求参数:

参数	数据类型	参数说明
section	int	版块ID
community	int	小区ID. 可传入当前操作人的小区ID.
principal	int	当前操作人ID
tag	int	标签（分类）ID
title	string	帖子标题
content	string	帖子内容
picture0	MultipartFile	帖子图片
picture1	MultipartFile	帖子图片
picture2	MultipartFile	帖子图片
picture3	MultipartFile	帖子图片
picture4	MultipartFile	帖子图片
picture5	MultipartFile	帖子图片
picture6	MultipartFile	帖子图片
picture7	MultipartFile	帖子图片
picture8	MultipartFile	帖子图片
picture9	MultipartFile	帖子图片
`*`	string	版块的特殊字段

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~
404	传入的版块ID`(section)`不存在	很抱歉，您正在查看的版块已删除，请刷新页面后重试！
406	特殊字段的格式错误，如日期的格式化错误	不合法的参数：{0}
507	上传图片导致文件系统错误	系统繁忙，请稍候重试……

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {           //刚刚发的帖子内容
            "id": 1,    //帖子ID
            "sectionId": 1,  //所属版块ID
            "communityId": 1,  //所属小区ID
            "customerId": 1,   //楼主ID
            "customerName": "朱先龙",  //楼主昵称
            "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png", //楼主头像
            "tag": "转让", //帖子标签（分类）
            "title": "转让全新格力电风扇一台。", //帖子标题
            "thumbnails": [{  //相片URL数组
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-md.png", //小图片
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-lg.png"//大图片
            },
            {
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-md.png",
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-lg.png"
            }],
            "createTime": "2014-07-24 17:35",  //发帖时间
            "replys": 0,    //回复数量
            "removable": true,  //是否允许删除 true-表示当前用户可以删除该帖子
            "favored": false,  //是否已收藏该帖子
            "content": "充话费送的，全新转让！",  //帖子内容
            "fields": [  //特殊字段
                {
                    "key": "价格",
                    "value": 28
                },
                {
                    "key": "新旧",
                    "value": "全新"
                },
                {
                    "key": "分类",
                    "value": "数码产品"
                }
            ]
        }
}

回复帖子

接口地址:
POST /bbs/topic/{id}/reply

路径参数：
id int 主题帖子ID.

请求参数:

参数	数据类型	参数说明
section	int	版块ID
community	int	小区ID. 可传入当前操作人的小区ID.
topicCustomerId	int	楼主ID
principal	int	当前操作人ID
content	string	帖子内容

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~

响应结果:

{
    "code": 0, //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": { //回复贴内容
        "id": 5, //回复贴ID
        "sectionId": 1, //所在版块
        "topicId": 1, //主题贴ID
        "topicCustomerId": 1, //楼主ID
        "communityId": 1, // 所属小区ID
        "customerId": 2,  //回复人ID
        "customerName": "admin", //回复人昵称
        "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v9.png",//回复人图像
        "communityName": "百商又一城",
        "content": "看了楼主的帖子,不由得精神为之一振,自觉七经八脉为之一畅,七窍倒也开了六巧半,自古英雄出少年, 楼主年纪轻轻,就有经天纬地之才,定国安邦之智,古人云,卧龙凤雏得一而安天下,而今,天佑我大中华,沧海桑田5000年,中华神州平地一声雷,飞沙走石,大舞迷天,朦胧中,只见顶天立地一金甲天神立于天地间,这人英雄手持双斧,二目如电,一斧下去,混沌初开,二斧下去,女娲造人,三斧下去,小生倾倒. 得此大英雄,实耐之幸也,民之福也,怎不叫人喜极而泣.......古人有少年楼主说为证,少年之楼主如红日初升,其道大光;河出伏流,一泻汪洋;潜龙腾渊,鳞爪飞扬;乳虎啸谷,百兽震惶;鹰隼试翼,风尘吸张;奇花初胎,皇皇;干将发硎,有作其芒;天戴其苍,地履其黄;纵有千古,横有八荒;小生对楼主之仰慕如滔滔江水连绵不绝,海枯石烂,天崩地裂,永不变心.", //回复内容
        "createTime": "2014-7-25 17:07", //回复时间
        "removable": true,  //当前住户是否可删除该回复标志
        "replies": [ ] //刚发的回复没有评论，此处可忽略
    }
}

评论回复

评论指对回复进行@操作，此文档中评论与@ 意义相同

接口地址:
POST /bbs/topic/{id}/at

路径参数：
id int 主题帖子ID.

请求参数:

参数	数据类型	参数说明
section	int	版块ID
community	int	小区ID. 可传入当前操作人的小区ID.
topicCustomerId	int	楼主ID
principal	int	当前操作人ID
reply	int	被@的回复ID
at	int	被@的住户ID
content	string	帖子内容

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": {  //评论贴内容
        "id": 5,    //评论贴ID
        "sectionId": 1,  //所属版块ID
        "topicId": 1,    //主题帖ID
        "topicCustomerId": 1,  //楼主ID
        "customerId": 1,  //评论人ID
        "customerName": "朱先龙",  //评论人昵称
        "replyId": 5,  //被@的回复
        "at": 2,       //被@的住户ID
        "atName": "admin",  //被@的住户昵称
        "content": "你的缺点就是在夸人的时候太含蓄了",  //评论内容
        "removable": //当前住户是否可删除该回复标志
    }
}

删除主题帖

删除主题帖会同时删除该主题贴下的所有回复和评论

接口地址:
POST /bbs/topic/{id}/remove

路径参数：
id int 主题帖子ID.

请求参数:

参数	数据类型	必填	参数说明
principal	int		当前操作人ID

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~
404	帖子已删除或不存在	很抱歉，您正在查看的帖子已删除，请刷新页面后重试！

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

删除主题回复帖

删除主题回复帖会同时删除其评论

接口地址:
POST /bbs/reply/{id}/remove

路径参数：
id int 回复帖ID

请求参数:

参数	数据类型	必填	参数说明
principal	int		当前操作人ID

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~
404	帖子已删除或不存在	很抱歉，您正在查看的帖子已删除，请刷新页面后重试！

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

删除评论贴

接口地址:
POST /bbs/replyat/{id}/remove

路径参数：
id int 评论贴ID

请求参数:

参数	数据类型	必填	参数说明
principal	int		当前操作人ID

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~
404	帖子已删除或不存在	很抱歉，您正在查看的帖子已删除，请刷新页面后重试！

响应结果:

{
    "code": 0,  //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": null
}

个人发帖列表

接口地址:
GET /customer/topic

eg. http://palmunity.hylapp.com:8080/apis/customer/topic?customerId=1

请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
start	int	分页参数——起始位置
size	int	分页参数——分页大小

运行时异常

code	错误原因	返回消息
401	未传入操作人ID	您需要重新登录才能继续操作哦~

响应结果:

{
    "code": 0,    //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": [
        {
            "id": 1,
            "sectionId": 1,
            "sectionName": "跳蚤街",
            "customerId": 1,
            "customerName": "朱先龙",
            "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png",
            "communityName": "金江苑",
            "title": "转让全新格力电风扇一台。",
            "image": [{  //相片URL数组
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-md.png", //小图片
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/8815a95d-e20f-4532-a6d7-1b3940404ada/ba34b26e8bff535d5d0fc67184772f16-lg.png"//大图片
            },
            {
                "md": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-md.png",
                "lg": "http://palmunity.hylapp.com/cust/7/trends/67/4f96224a-221b-4c57-8708-7a517e4e94b4/cd4143583a2ab02758304eacaf2eb0fd-lg.png"
            }],
            "createTime": "2014-07-28 18:37",
            "replys": 2
        },
        ...
    ]
}

我的回帖

接口地址:
GET /customer/reply

eg. http://palmunity.hylapp.com:8080/apis/customer/reply?customerId=1

请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
start	int	分页参数——起始位置
size	int	分页参数——分页大小

响应结果:

{
    "code": 0,    //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": [
        {
            "id": 1,
            "level": 2,
            "sectionId": 1,
            "tagName": "转让",
            "sectionName": "跳蚤街",
            "customerId": 1,
            "customerName": "朱先龙",
            "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v5.png",
            "communityName": "金江苑",
            "content": "已经是最低价了哦",
            "title": "转让全新格力电风扇一台。",
            "createTime": "2014-07-28 18:37",
            "replys": 2
        },
        ...
    ]
}

回复我的

接口地址:
GET /customer/replied

eg. http://palmunity.hylapp.com:8080/apis/customer/replied?customerId=1

请求参数:

参数	数据类型	参数说明
customerId	int	用户ID
start	int	分页参数——起始位置
size	int	分页参数——分页大小

响应结果:

{
    "code": 0,    //0 - 接口调用成功，其他值表示失败
    "message": null,
    "data": [
        {
            "id": 1,
            "level": 1,
            "tagName": "转让",
            "sectionId": 1,
            "sectionName": "跳蚤街",
            "customerId": 2,
            "customerName": "admin",
            "customerAvatar": "http://www.hylapp.com:8084/console/img/avatar/v9.png",
            "communityName": "金江苑",
            "content": "可以便宜点吗？",
            "title": "转让全新格力电风扇一台。",
            "createTime": "2014-07-28 18:37",
            "replys": 2
        },
        ...
    ]
}