API Doc

API草稿

// 这里引入一个detail object是考虑到到时候应用场景会分为简要信息和详细信息，必要性有待商榷

(1)Function: 
	getClubInfo(club_id) 
Return:
	 {status: ‘’, club_id: ‘’, club_name: ‘’, club_school: ‘’, club_icon: ‘’, club_picture: ‘’, club_info_detail: ‘’, …}

	club_info_detail: {introduction: ‘’, contact: ‘’, club_manager: ‘’, join_requirements: ‘’, pictures: ‘’, associated_activities: ‘’, …}

(2)Function: 
	getActivityInfo(activity_id)
Return: 
	{status: ‘’, activity_id: ‘’, activity_name: ‘’, associated_club_id: ‘’, activity_info_detail: ‘’, …}

	activity_info_detail: {introduction: ‘’, time: ‘’, place: ‘’, fee: ‘’, requirements: ‘’, expected_numbers: ‘’, pictures: ‘’, …}


(3)Function: 
	getClubList()

Return : 
	{status: ‘’, club_list: [ getClubInfo(id) for id in ALL_CLUB_ID ]}

(4)Function: 
	getRecommendClubList(wx_id)
Return: 
	{status: ‘’, recommendClubList: ‘’}

(5)Function: 
	getActivityList()

Return: 
	{ status: ‘’, activity_list: [ getActivityInfo(id) for id in ALL_ACTIVITY_ID ]}

(6)Function: 
	getRecommendActivityList(wx_id)

Return: 
	{status: ‘’, recommendActivityList: ‘’}

(7)Function: 
	getAccountInfo(wx_id)

Return: 
	{status: ‘’, wx_id: ‘’, associated_club: ‘’, associated_activity: ‘’, associated_comments, authorization: ‘’, 个人信息: ‘’, …}

(8)Function: 
	setAccountInfo(wx_id, new_account_info)

Return: 
	{status: ‘’}

(9)Function: 
	setClubInfo(club_id, new_club_info)

Return : 
	{ status: ‘’}

(10)Function
	setActivityInfo(activity_id, new_activity_info)

Return: 
	{status: ‘’}

(11)Function: 
	getMessages(wx_id)

Return: 
	{status: ‘’, message_list: [ {type: ‘’, title: ‘’, content: ‘’, sender: ‘’, receiver: ‘’, …} , …], …}

(12)Function: 
	sendMessage(wx_id_sender, wx_id_receiver, type, title, content)

Return: 
	{status: ‘’}

(13)Function: 
	searchClub(club_id)
Return:
	{status: ‘’, results: ‘’}

(14)Function:
	searchActivity(activity_id)
Return:
	{status: ‘’, results: ‘’}

社团、活动、人员三个类的属性 Club：{ id， name， 分类标签（体育、文化等）， 封面， 介绍内容（文字+图片）， 活动介绍, 关联活动id， 联系方式（公众号二维码）， 入会费用， 社长id， 管理员id， 成员id， 收藏者id }

活动：{ id, name, 活动介绍， 关联社团id， 活动图片（封面、介绍）， 报名截止时间， 抽签结果公布时间， 活动开始时间， 活动结束时间， 活动报名人员id， 活动入选人员id， 收藏者id， 报名费用， 抽签方法， }

人员：{ openid, 昵称， 年龄， 性别， 认证信息（专业，学号）， 关联社团id（加入的，创建的，收藏的，管理的）， 关联活动id（加入的，收藏的，发布的）， 关联消息id， }

get、set等API接口主要就是获取和上传上述三个类的属性信息