Plus (ThinkSNS+)

# 活动

# 单条活动数据结构

{
    "id": 3,
    "title": "1234",  // 活动标题
    "category": { // 活动分类
        "id": 1,
        "name": "普通活动", // 分类名字
        "avatar": {    //  分类图标
            "url": "http://plus-domo.test/storage/public:MjAxOS8xMS8yNi9IaFB3UURLZ25xUTVsUkdtdEJxbjJvTnJjazk1SXlMWHVnd2pmbExBc1FNcGJZM0ZhUFprRzg3dzB5U3RmZDF1LmpwZw==",
            "vendor": "local",
            "mime": "image/jpeg",
            "size": 17555,
            "dimension": {
                "width": 200,
                "height": 200
            }
        }
    },
    "creator": { // 活动创建者
        "id": 1,
        "name": "root",
        "email": null,
        "phone": null,
        "bio": null,
        "sex": 0,
        "location": null,
        "invite_code": "10ABC0",
        "avatar": null,
        "feed_topics_count": 1,
        "verification": null,
        "has_follower": false,
        "has_following": false,
        "created_at": "2019-11-29T06:41:52Z",
        "updated_at": "2019-11-29T10:23:27Z"
    },
    "user_id": 1, // 活动创建者 id
    "avatar": {   // 活动封面
        "url": "http://plus-domo.test/storage/public:MjAxOS8xMS8yNi9IaFB3UURLZ25xUTVsUkdtdEJxbjJvTnJjazk1SXlMWHVnd2pmbExBc1FNcGJZM0ZhUFprRzg3dzB5U3RmZDF1LmpwZw==",
        "vendor": "local",
        "mime": "image/jpeg",
        "size": 17555,
        "dimension": {
            "width": 200,
            "height": 200
        }
    },
    "wantJoin": true,  // 想参加， true 已经提价想参加， false 未操作
    "want_joins_count": 1, // 有多少人想参加
    "interested": false,   // 感兴趣
    "interesteds_count": 0, // 感兴趣的数量
    "date": "2019-12-03 14:40:00", // 活动进行的日期
    "content": "hhhh",   // 活动说明内容
    "area": "四川省 成都市 高新区", // 活动进行的地区
    "address": null, // 活动进行的详情地址
    "expense": 0,   // 活动人均费用，单位 分
    "validate": 1  // 验证，暂未使用
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# 活动接口

# 创建活动

POST  api/v2/events
1

传递参数

参数 类型 描述
title string 必选, 活动名称，2-30个汉字
category_id integer 必选, 活动分类ID
avatar string 必选, 活动封面，文件node
date datetime 必选, 活动时间，必须大于当前时间
content string 必选, 活动内容，小于65000字节
area string 可选, 和address至少存在一项
address string 可选, 和area至少存在一项
expense integer 可选, 活动费用，分为单位
latitude Double 可选, 活动纬度
longitude Double 可选, 活动经度

响应:

Status: 201 Created
1

响应体: 单个活动结构

# 获取单条活动

GET api/v2/events/{evnetId}
1

响应:

Status: 200 OK
1

响应体：单个活动结构

# 活动列表

GET api/v2/events
1

参数列表：

参数 类型 描述
recommended integer 可选, recommended=1 返回推荐列表
keyword string 可选, 对活动名称进行搜索
c integer 可选, 根据活动分类进行筛选
area string 可选, 根据地区筛选
offset string 可选, 数据偏移量
limit string 可选, 分页量
user_id integer 可选, 某个用户的活动
page string 可选, page分页模式，与offset二选一
ob string 可选, 排序默认会将超过当前时间的活动排到最后，并且为date asc排序, 支持： id:{desc,asc}, date:{desc,asc}

响应:

Status: 200 OK
1
[
{单个活动}
]
1
2
3
4

# 想要参加活动

POST api/v2/events/{eventId}/want-join
1

响应:

Status: 204 No Content
1

对于已经加入过的和未加入过的，请求该接口都返回204状态

# 对活动感兴趣

POST api/v2/events/{eventId}/interest
1

响应:

Status: 204 No Content
1

对于已经感兴趣的和未感兴趣的，请求该接口都返回204状态

# 删除活动

DELETE api/v2/events/{eventId}
1

删除成功响应:

Status: 201 Created
1

删除失败响应, 无权删除:

Status: 403 Forbidden
1

删除失败响应, 没有找到对应的活动:

Status: 404 Not Found
1

# 发布活动点评

发布点评调用发布动态的接口，其中 repostable_type 设置为 event，repostable_id 设置要点评的活动ID。

# 获取活动点评

获取指定活动点评

GET /api/v2/events/{eventId}/comments
1

获取全部活动点评

GET /api/v2/events/comments
1

查询参数：

参数 类型 描述
type string 可选，要获取的评论类型，默认全部，选项：
image仅获取带图片的评论
video仅获取带视频的评论
image_or_video 获取带图片或视频的评论
after integer 可选，本地最后一条数据的ID
order string 可选，默认 desc，可选 asc,desc
limit integer 可选，获取条数，默认15

响应：

Status: 200 OK
1
[
  {/*  单个动态数据 */}
]
1
2
3

# 活动分类

# 活动分类数据结构

{
  "id": 1,
  "name": "普通活动", // 活动标题
  "avatar": {  // 活动封面
      "url": "http://plus-domo.test/storage/public:MjAxOS8xMS8yNi9IaFB3UURLZ25xUTVsUkdtdEJxbjJvTnJjazk1SXlMWHVnd2pmbExBc1FNcGJZM0ZhUFprRzg3dzB5U3RmZDF1LmpwZw==",
      "vendor": "local",
      "mime": "image/jpeg",
      "size": 17555,
      "dimension": {
          "width": 200,
          "height": 200
      }
  },
  "sort": 0, // 活动分类排序字段，越大越靠前
  "parent_id": 0, // 父级分类
  "events_count": 7 // 分类下的活动数量
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 活动分类列表

GET api/v2/event-categories
1

查询参数：

参数 类型 描述
keyword string 可选, 对活动名称进行搜索
offset string 可选, 数据偏移量
limit string 可选, 分页量
page string 可选, page分页模式，与offset二选一

响应:

Status: 200 OK
1

响应内容 [单个活动分类...]

# 获取单个活动分类

GET api/v2/event-categories/{event-category-id}
1

响应:

Status: 200 OK
1

响应体： 响应内容 单个活动分类