第一章、概述

1.1 会话保持

sparrow-web-api是基于springboot的web服务端应用。与其它前后端分离架构的服务端不同的是，sparrow-web-api并非“无状态”的，仍会使用cookie保持会话，因而要求客户端在使用XHR发起请求时，需要设置withCredentials为true，以允许为跨域请求提供凭证信息（即cookie）。

1.2 开发约束

项	值	说明
HTTP Method	POST	-
Encoding	UTF-8	-
客户端API	XHR	-
数据交换格式	json	-

1.3 鉴权

客户端在携带用户信息调用API时，服务端会提供匿名、身份验证和授权三种不同级别的安全策略：

级别	图例	说明
匿名		无任何安全要求
身份验证		用户登录成功后才可以调用，否则返回未登录错误（XXX_001_B_020）
授权		用户登录成功后，且具备对应权限才可以调用，否则返回未授权错误（XXX_001_B_023）

1.4 关于返回值

所有API在未特殊说明的情况下，均返回如下架构：

字段	类型	说明
code	String	错误代码，用来表示请求是否被正常处理；通过错误码可以区分不同的错误
data	Object	data为响应数据
message	String	message为本次调用失败的具体信息

当API调用成功时，code为”OK”并由data返回响应数据。以用户登录为例，成功时API将返回重定向地址：

{"code": "OK","data": "/","message": null
}

当API调用失败时，code为错误代码并由message返回具体信息。同样以用户登录为例，当用户提供了错误的密码时将返回：

{"code": "XXX_001_P_019","data": null,"message": "您的密码错误，请重新输入"
}

code有四组数据：应用代码、模块代码、类型代码和错误代码组成。

第二章、API

2.1 用户登录

sparrow-web-api支持用户使用账号密码或者短信验证码进行登录。对于使用账号密码登录的，还需要用户提供图形验证码。

2.1.1 获取图形验证码 /sec/login/captcha

字段	类型	允许为空	默认值	说明
请求参数
width	int	否		验证码图片宽度
height	int	否		验证码图片高度
length	int	否		验证码长度
返回值
data	Object	否
+token	int	否		验证码口令
+image	int	否		图形经base64编码后的字符串

2.1.2 获取短信验证码 /sec/login/sms-code

字段	类型	允许为空	默认值	说明
请求参数
mp	String	否		手机号码
返回值
data	long	否		距离下次获取短信验证码的时间间隔（秒）

2.1.3 使用账号密码登录 /sec/login/password

字段	类型	允许为空	默认值	说明
请求参数
username	String	否		账号
password	String	否	0	密码，需使用md5算法加密
captcha	Object	否
+token	String	是	null	请求图形验证码时返回的验证码口令
+text	String	否		验证码
redirect	String	是	null	重定向地址，服务端可返回302状态码重定向到目的地址
返回值
data	String	是	null	重定向地址

2.1.4 使用短信验证码登录 /sec/login/sms

字段	类型	允许为空	默认值	说明
请求参数
mp	String	否		手机号码
smsCode	String	否		短信验证码
rememberMe	boolean	否		是否保持登录，允许用户在一定时期内（30天）无需登录即可访问API
redirect	String	是	null	重定向地址，服务端可返回302状态码重定向到目的地址
返回值
data	String	是	null	重定向地址

2.1.5 使用小程序账号登录 /sec/login/mini-app/register

使用小程序账号登录的用户，会根据openId和手机号码判断用户是否已存在，否则将自动注册。

字段	类型	允许为空	默认值	说明
请求参数
nickname	String	否		昵称
code	String	否		授权码
encryptedData	boolean	否
iv	String	否
返回值
data	User	否		登录用户信息

2.1.6 注销登录 /sec/login/cancel

字段	类型	允许为空	默认值	说明
请求参数
-
返回值
-

2.1.7 修改密码 /sys/user/password/change

字段	类型	允许为空	默认值	说明
请求参数
originalPassword	String	否		原密码，需使用md5算法加密
newPassword	String	否		新密码，需使用md5算法加密
返回值
data	List<Menu>	否		菜单

2.2 用户信息

2.2.1 获取个人信息 /sec/profile

字段	类型	允许为空	默认值	说明
请求参数
-
返回值
data	User	否		用户信息

2.2.2 修改个人信息 /sec/profile/save

字段	类型	允许为空	默认值	说明
请求参数
name	String	否		姓名
alphabet	String	否		拼音
profilePictureId	String	是	null	头像图片id
mp	String	是	null	手机号码
email	String	是	null	电子邮箱地址
birthday	Date	是	null	生日
address	String	是	null	联系地址
isMale	boolean	否	false	性别：false为女性，true为男性
返回值
data	String	否		用户id

2.2.3 获取当前用户角色 /app/layout/roles

字段	类型	允许为空	默认值	说明
请求参数
-
返回值
data	List<Role>	否		角色信息

2.2.4 获取菜单 /app/layout/menu

sparrow-web-api的菜单将在启动时自动创建或更新，API仅提供查询功能：

字段	类型	允许为空	默认值	说明
请求参数
-
返回值
data	List<Menu>	否		菜单

2.3 系统管理

2.4 两会管理

2.4.1 国际潮团联谊年会

2.4.1.1 保存简介 /cms/article/save

字段	类型	允许为空	默认值	说明
请求参数
id	String	是	null	文章唯一标识，如未提供则为新增，否则为更新
themeId	String	否	FEDERATION_INTRO	固定为FEDERATION_INTRO
title	String	否		标题
subtitle	String	是	null	副标题
body	String	否		正文
coverIds	List<String>	是	null	封面图片id列表
attachmentIds	List<String>	是	null	附件id列表
status	String	否		状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	String	否		文章id

2.4.1.2 获取简介

获取简介需要先通过模糊搜索（/cms/article/fuzzy）获取文章列表：

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		固定为1
index	int	否		固定为0
themeId	String	否		固定为FEDERATION_INTRO
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Article>	否		文章列表

再使用文章列表第一个元素获取详情（/cms/article/get）：

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
data	Article	否		文章详情

2.4.1.3 审核 /cms/article/audit

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
status	String	否		状态：DRAFT为草稿，PUBLISHED为已发布
返回值
-

2.4.1.4 前世今生

ThemeId固定为FEDERATION_HISTORY，API同章节2.8。

2.4.1.5 精彩回顾

ThemeId固定为FEDERATION_REVIEW，API同章节2.8。

2.4.2 国际潮商大会

2.4.2.1 保存简介 /cms/article/save

字段	类型	允许为空	默认值	说明
请求参数
id	String	是	null	文章唯一标识，如未提供则为新增，否则为更新
themeId	String	否	CONVENTION_INTRO	固定为CONVENTION_INTRO
title	String	否		标题
subtitle	String	是	null	副标题
body	String	否		正文
coverIds	List<String>	是	null	封面图片id列表
attachmentIds	List<String>	是	null	附件id列表
status	String	否		状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	String	否		文章id

2.4.2.2 获取简介

获取简介需要先通过模糊搜索（/cms/article/fuzzy）获取文章列表：

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		固定为1
index	int	否		固定为0
themeId	String	否		固定为CONVENTION_INTRO
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Article>	否		文章列表

再使用文章列表第一个元素获取详情（/cms/article/get）：

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
data	Article	否		文章详情

2.4.2.3 审核 /cms/article/audit

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
status	String	否		状态：DRAFT为草稿，PUBLISHED为已发布
返回值
-

2.4.2.4 前世今生

themeId固定为CONVENTION_HISTORY，API同章节2.8。

2.4.2.5 精彩回顾

themeId固定为CONVENTION_REVIEW，API同章节2.8。

2.4.3 实时资讯

themeId固定为CONFERENCE_BROADCAST，API同章节2.8。

2.4.4 大会倒计时

大会倒计时本质上是使用字典来管理，所以API也是在字段管理的API上做一些请求参数的限制：

2.4.4.1 保存 /sys/dictionary/save

字段	类型	允许为空	默认值	说明
请求参数
id	String	是	null	字典项唯一标识，如未提供则为新增，否则为更新
groupId	String	否		固定为大会倒计时
name	String	否		固定为大会倒计时
val	String	否		日期，格式为yyyy-MM-dd
返回值
data	String	否		字典项id

2.4.4.2 搜索 /sys/dictionary/fuzzy

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		固定为1
index	int	否		固定为0
groupId	String	是	null	固定为大会倒计时
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总数
+items	List<Dictionary>	否		字典列表

2.5 潮属社团管理

2.5.1 社团管理

2.5.1.1 模糊搜索 /federation/association/fuzzy

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
index	int	否		分页，起始索引（从0开始索引）
region	String	是	null	国家/地区
name	String	是	null	名称
official	boolean	是	null	是否正式潮团
published	boolean	是	null	是否开放访问
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Association>	否		社团列表

2.5.1.2 开放访问 /federation/association/publish

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		社团id
返回值
-

2.5.2 社团申请

2.5.2.1 模糊搜索 /federation/association/member/form/query

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
index	int	否		分页，起始索引（从0开始索引）
sortBy	List<Object>	是	null
+field	String	否		排序字段，支持status、createTime
+asc	boolean	否		是否按升序排列
associationName	String	是	null	潮团名称
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
status	String	是	null	状态：DRAFT为草稿，PASSED为审核通过，REJECTED为拒绝
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<MemberRegistrationForm>	否		申请单列表

2.5.3 资讯管理

2.5.3.1 模糊搜索 /federation/association/news/fuzzy

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
index	int	否		分页，起始索引（从0开始索引）
associationId	String	否		潮团id
keyword	String	是	null	关键字
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
status	String	是	null	状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<FederationAssociationNews>	否		文章列表

2.5.3.2 懒加载 /federation/association/news/load

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
previousSN	long	是	0	起始序列号
associationId	String	否		潮团id
keyword	String	是	null	关键字
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<FederationAssociationNews>	否		文章列表

2.5.3.3 保存 /federation/association/news/save

字段	类型	允许为空	默认值	说明
请求参数
id	String	是	null	文章唯一标识，如未提供则为新增，否则为更新
themeId	String	否	FEDERATION_ASSOCIATION_NEWS	固定为FEDERATION_ASSOCIATION_NEWS
associationId	String	否		潮团id
title	String	否		标题
subtitle	String	是	null	副标题
body	String	否		正文
coverIds	List<String>	是	null	封面图片id列表
attachmentIds	List<String>	是	null	附件id列表
status	String	否		状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	String	否		文章id

2.5.3.4 删除 /federation/association/news/remove

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
-

2.5.3.5 获取详情 /federation/association/news/get

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
data	FederationAssociationNews	否		文章详情

2.5.3.6 审核 /federation/association/news/audit

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
status	String	否		状态：DRAFT为草稿，PUBLISHED为已发布
返回值
-

2.5.3.7 取消发布 /federation/association/news/retract

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
-

2.5.4 运营人员管理

2.5.5 成员管理

2.6 家人风采管理

2.6.1 模糊搜索 /convention/compatriot/intro/fuzzy

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
index	int	否		分页，起始索引（从0开始索引）
keyword	String	是	null	关键字
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
status	String	是	null	状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<CompatriotIntro>	否		文章列表

2.6.2 懒加载 /convention/compatriot/intro/load

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
previousSN	long	是	0	起始序列号
name	String	是	null	姓名
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<CompatriotIntro>	否		文章列表

2.6.3 保存 /convention/compatriot/intro/save

字段	类型	允许为空	默认值	说明
请求参数
id	String	是	null	文章唯一标识，如未提供则为新增，否则为更新
themeId	String	是	COMPATRIOT_INTRO	固定为COMPATRIOT_INTRO
title	String	否		标题
subtitle	String	是	null	副标题
body	String	否		正文
name	String	否		姓名
birthplace	String	否		籍贯
birthday	String	否		生日，格式为yyyy-MM-dd
duty	String	否		职务
intro	String	否		人物简介
profilePictureId	String	否		头像图片id
coverIds	List<String>	是	null	封面图片id列表
attachmentIds	List<String>	是	null	附件id列表
status	String	否		状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	String	否		文章id

2.6.4 删除 /convention/compatriot/intro/remove

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
-

2.6.5 获取详情 /convention/compatriot/intro/get

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
data	CompatriotIntro	否		文章详情

2.6.6 审核 /convention/compatriot/intro/audit

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
status	String	否		状态：DRAFT为草稿，PUBLISHED为已发布
返回值
-

2.6.7 取消发布 /convention/compatriot/intro/retract

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
-

2.7 侨乡风采/文化习俗/家园资讯/家园服务/家乡味道管理

2.7.1 模糊搜索 /cms/article/fuzzy

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
index	int	否		分页，起始索引（从0开始索引）
themeId	String	否		主题：侨乡风采为SCENE，文化习俗为CULTURE，家园资讯为INFO，家园服务为SERVICE，家乡味道为SNACK
keyword	String	是	null	关键字
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
status	String	是	null	状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Article>	否		文章列表

2.7.2 懒加载 /cms/article/load

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
previousSN	long	是	0	起始序列号
themeId	String	否		主题：侨乡风采为SCENE，文化习俗为CULTURE，家园资讯为INFO，家园服务为SERVICE，家乡味道为SNACK
keyword	String	是	null	关键字
recommended	boolean	是	false	是否只获取推荐文章
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Article>	否		文章列表

2.7.3 保存 /cms/article/save

字段	类型	允许为空	默认值	说明
请求参数
id	String	是	null	文章唯一标识，如未提供则为新增，否则为更新
themeId	String	否		主题：侨乡风采为SCENE，文化习俗为CULTURE，家园资讯为INFO，家园服务为SERVICE，家乡味道为SNACK
title	String	否		标题
subtitle	String	是	null	副标题
body	String	否		正文
coverIds	List<String>	是	null	封面图片id列表
attachmentIds	List<String>	是	null	附件id列表
status	String	否		状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	String	否		文章id

2.7.4 删除 /cms/article/remove

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
-

2.7.5 获取详情 /cms/article/get

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
data	Article	否		文章详情

2.7.6 审核 /cms/article/audit

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
status	String	否		状态：DRAFT为草稿，PUBLISHED为已发布
返回值
-

2.7.7 取消发布 /cms/article/retract

字段	类型	允许为空	默认值	说明
请求参数
id	String	否		文章id
返回值
-

2.8 精选管理

2.8.1 模糊搜索文章 /cms/digest/fuzzy/article

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
index	int	否		分页，起始索引（从0开始索引）
keyword	String	是	null	关键字
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
status	String	是	null	状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Article>	否		文章列表

2.8.2 懒加载文章 /cms/digest/load/article

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
previousSN	long	是	0	起始序列号
name	String	是	null	姓名
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Article>	否		文章列表

2.8.3 模糊搜索活动 /cms/digest/fuzzy/activity

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
index	int	否		分页，起始索引（从0开始索引）
keyword	String	是	null	关键字
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
status	String	是	null	状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Activity>	否		文章列表

2.8.4 懒加载活动 /cms/digest/load/activity

字段	类型	允许为空	默认值	说明
请求参数
count	int	否		分页，返回记录数
previousSN	long	是	0	起始序列号
name	String	是	null	姓名
beginDate	Date	是	null	开始日期（格式为yyyy-MM-dd HH:mm:ss）
endDate	Date	是	null	结束日期（格式为yyyy-MM-dd HH:mm:ss）
返回值
data	Object	否
+count	int	否		分页，返回记录数
+index	int	否		分页，起始索引（从0开始索引）
+total	int	否		总文章数
+items	List<Activity>	否		文章列表

2.8.5 加精选 /cms/digest/add

字段	类型	允许为空	默认值	说明
请求参数
articleId	String	否		文章/活动id
themeId	String	否		主题id
type	String	否		类型：ARTICLE为文章，ACTIVITY为活动
返回值
-

2.8.6 删除精选 /cms/digest/remove

字段	类型	允许为空	默认值	说明
请求参数
articleId	String	否		文章/活动id
themeId	String	否		主题id
返回值
-

三、附录

3.1 数据结构

3.1.1 系统

3.1.1.1 用户 User

字段	类型	说明
id	String	用户id
account	String	登录账号
name	String	姓名
alphabet	String	姓名拼音
deptId	String	部门id
profilePictureId	String	头像图片id
mp	String	手机号码
email	String	电子邮箱地址
birthday	Date	生日
adddress	String	联系地址
unionId	String	微信公众平台unionId
maOpenId	String	微信小程序openId
isMale	boolean	性别：false为女性，true为男性
isEnabled	boolean	是否启用

3.1.1.2 部门 Department

字段	类型	说明
id	String	部门id
name	String	部门名称
superiorId	String	上级部门id
code	String	部门编码，以.分割各级部门
fullName	String	部门全称，以/分割各级部门
level	int	部门级别，1为最高级别
isEnabled	boolean	是否启用

3.1.1.3 组织架构 Organization

字段	类型	说明
dept	Department	当前部门
members	List<User>	当前部门成员（非递归）
subordinates	List<Department>	下级部门（非递归）

3.1.1.4 角色 Role

字段	类型	说明
id	String	角色id
name	String	名称
description	String	描述

3.1.1.5 权限 Permission

字段	类型	说明
id	String	权限id
parentId	String	父级权限id
level	int	级别，1为最高级别
type	String	资源类型：API为接口资源，PAGE为页面资源
resource	String	资源标识，当type为PAGE时，resource为页面的URL
description	String	描述

3.1.1.6 菜单项 Menu

字段	类型	说明
id	String	菜单项id
parentId	String	父级菜单项id
title	String	标题
icon	String	图标
level	int	级别，1为最高级别
seq	int	排序
description	String	描述
requireAuthenticated	boolean	是否要求身份验证后访问
requireAuthorized	boolean	是否要求授权后访问

3.1.1.7 字典项 Dictionary

字段	类型	说明
id	String	字典项id
groupId	String	分组
name	String	键
val	String	值
buildIn	boolean	是否内置变量，内置变量不允许删除
readonly	boolean	是否只读变量，只读变量不允许修改
isEnabled	boolean	是否启用

3.1.2 潮属社团

3.1.2.1 社团 Association

字段	类型	说明
id	String	社团id
name	String	名称
alphabet	String	拼音，用于排序
region	String	国家/地区
badgeId	String	会徽图片id
backgroundId	String	背景图片id
coverIds	List<String>	封面图片id
intro	String	简介
president	String	会长/主席
formerPresident	String	荣誉会长/主席
honoraryPresident	String	名誉会长/主席
executiveVicePresident	String	常务副会长/主席
vicePresident	String	副会长/主席
executiveChairman	String	执行会长/主席
executiveViceChairman	String	执行副会长/主席
chiefSupervisor	String	监事长
secretaryGeneral	String	秘书长
deputySecretaryGeneral	String	副秘书长
director	String	理事
supervisor	String	监事
member	String	会员
leader	String	领导
website	String	官网
address	String	地址
telephone	String	电话
communication	String	通讯媒体
foundTime	Date	成立时间
official	boolean	是否正式社团，申请潮团时将登记为false，审批通过后将设置为true
published	boolean	是否开放访问

3.1.2.2 申请表 MemberRegistrationForm

字段	类型	说明
id	String	申请表id
associationId	String	潮团id
associationName	String	潮团名称
name	String	申请人姓名
region	String	国家/地区
contact	String	联系方式
industry	String	从事行业
workplace	String	工作单位
address	String	联系地址
asAdmin	boolean	是否申请运营人员职务
title	String	标题
subtitle	String	副标题
body	String	正文
attachmentIds	List<String>	附件id列表
attachments	List<Media>	附件列表
options	String	审批意见
status	String	状态：DRAFT为草稿，PASSED为通过，REJECTED为拒绝

3.1.2.3 潮团资讯 FederationAssociationNews

字段	类型	说明
id	String	文章id
sn	long	序号
themeId	String	主题，固定为FEDERATION_ASSOCIATION_NEWS
associationId	String	潮团id
title	String	标题
subtitle	String	副标题
body	String	正文
address	String	地址
lng	Double	经度
lat	Double	纬度
coverIds	List<Srting>	封面图片id列表
attachmentIds	List<String>	附件id列表
attachments	List<Media>	附件列表
status	String	状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布

3.1.3 潮商大会

3.1.3.1 侨胞介绍 CompatriotIntro

字段	类型	说明
id	String	文章id
name	String	姓名
birthplace	String	籍贯
birthday	Date	生日
duty	String	职务
intro	String	人物简介
profilePictureId	String	头像图片id
sn	long	序号
themeId	String	主题，固定为COMPATRIOT_INTRO
title	String	标题，同姓名
subtitle	String	副标题
body	String	正文
coverIds	List<Srting>	封面图片id列表
attachmentIds	List<String>	附件id列表
attachments	List<Media>	附件列表
status	String	状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布

3.1.4 内容管理

3.1.4.1 文章 Article

字段	类型	说明
id	String	文章id
sn	long	序号
themeId	String	主题
title	String	标题
subtitle	String	副标题
body	String	正文
address	String	地址
lng	Double	经度
lat	Double	纬度
coverIds	List<Srting>	封面图片id列表
attachmentIds	List<String>	附件id列表
attachments	List<Media>	附件列表
status	String	状态：DRAFT为草稿，EDIT为待审核，PUBLISHED为已发布