ShuRenZhiDaoWEBAPI 9.88 KB

0.其他
	0.1 所有接口返回格式{"state":1,"data":"jsonarray or jsonobject"} , state 1成功 0失败

	0.2 下面所有需要分页的接口都会增加如下参数: index:第几页,从0开始  size:每页大小


1.首页
	1.1 频道分类
		1.1.1 获取频道接口
			权限:全部
			参数:无
			返回:返回所有频道列表,频道数据包括频道名字,频道ID,是否是我的频道。通过“是否是我的频道”字段区分类型。
		1.1.2 设置我的频道接口
			权限:登录用户
			参数:频道ID列表
			返回:是否设置成功

	1.2 首页新闻
		1.2.0 新闻列表数据格式(暂定)
			文章ID:
			文章类型:普通文章还是广告文章
			预览图:列表里显示的小图
			封面图:用于滚动显示的大图(没有可以不返回)
			新闻标题:
			浏览点击量:
			发布时间:时间戳,单位秒
			文章地址:这个可以直接给地址,也可以我们自己拼,你看吧。

		1.2.1 新闻列表接口
			权限:全部
			参数:频道id , 需分页
			返回:返回该频道下的全部新闻,格式见1.2.0
		1.2.2 轮播新闻列表
			权限:全部
			参数:无
			返回:全部的轮播新闻,格式见1.2.0

		1.2.3 关于随机广告
			如果新闻列表接口服务端已经随机加入广告了,那就不用广告列表接口了。如果要APP随机加,那就增加个返回全部广告文章的接口。
			
2、我的班级

	2.1、首页帖子列表
		权限:登录用户
		参数:分页
		返回:帖子信息列表

			2.1.1、帖子信息列表数据格式(暂定)
			data:[
					{
						id(Integer):唯一标识
						title(String):标题,
						type(String):帖子类型
						content(String):内容,
						chatCount(Integer):回帖数(评论数),
						praiseCount(String):点赞数,
						userId(integer):发帖人身份id,
						userImg(String):发帖人头像url,
						userName(String):发帖人昵称
						time(Integer):帖子发布时间戳
					},...,
					{...}
				]


	2.2、加入班级圈
		权限:登录用户(家长、教师身份)
		参数:学校id、班级id、身份类型、姓名(昵称)
		返回:是否加入成功

	2.3、任课任职申请
		权限:教师身份的登录用户
		参数:学校id、班级id、职位编号、验证者的信息{id、身份类型}
		返回:递交申请是否成功
		
	2.4、获取验证者信息列表
		权限:教师身份的登录用户
		参数:学校id、班级id
		返回:验证者信息
		
		2.4.1、验者信息列表数据格式
			data:[
					{
						userId:用户id
						userName:用户昵称
						worker:职称  0-老师   1-家长
						userImg:用户头像url
					}
				 ]
	2.5、认证教师
		权限:登录用户
		参数:无
		返回:待认证的用户
		
		2.5.1、待认证用户数据格式
			data:[
					{
						userId:认证用户id,
						userName:认证用户的昵称
						authId:认证用户任职的职务id
						authName:认证用户任职的职务
					}
				 ]
	2.5-1、同意认证接口
		功能:被邀请认证后,本人同意此人任职
		权限:登录用户
		参数:用户id,用户职务id
		返回:操作是否成功
	2.6、发布帖子
		权限:登录用户(家长、教师身份)
		参数:用户身份类型、用户昵称、帖子标题、帖子类型、帖子内容、附件(图片)信息:{图片url}
		返回:是否发帖成功

	2.7、评论帖子
		权限:登录用户
		参数:帖子id、评论的内容
		返回:是否评论成功

	2.8、帖子点赞
		权限:登录用户
		参数:帖子id
		返回:是否点赞成功
		
	
	2.9、返回评论列表
		权限:登录用户
		参数:帖子id,分页
		返回:帖子评论列表
		
		2.9.1、评论列表数据格式
			comment(Array):[{
								userId(integer):评论者身份id,
								userImg(String):评论者头像url,
								userName(String):评论者昵称,
								time(Integer):评论发布的时间戳,
								content(String):评论内容
							}]
	2.10.获取要加入的学校和班级
	    权限:登录用户
	    参数:用户id
	    返回:学校班级列表[
	                        schoolName,
	                        schoolid,
	                        [
	                            className,
	                            classid
	                        ]]
	2.11.获取用户可以任职的职务
	    权限:登录用户
	    参数:无
	    返回:身份列表[
	                    authId,职称id
	                    authName职称名称
	                    ]
	    
3.直播点播大厅:
	3.1 获取全部分类
		权限:全部
		参数:类型(直播还是点播)
		返回:[{
				年段id
				年段名字
				其他等
				年段下的年级列表:[{
					年级id
					年级名字
					其他等
					年级下的科目列表:[{
						科目id
						科目名字
						其他等
					},{}
					]

				},{}
				]
				},{

				}]
	3.2 根据分类获取直播点播列表
		权限:全部
		参数:分页参数,类型(或者分2个不同接口),年段id,年级id(0或空时表示全部年级),科目id(0或空时表示全部科目,有值时可以忽略前面2个id)
		返回:直播(点播)列表
	3.3 最热列表
		3.3.1 最热直播(点播)首页和更多分页接口
			权限:全部
			参数:index:第几页,从0开始  size:每页大小,类型(直播还是点播)
			返回:最热直播列表
	3.4 课程数据格式
	    3.4.1 数据格式
		    课程ID
		    课程创建人
			    创建人名字
			    创建人职称
		    名字
		    封面
		    地址
		    价格:10元  0元表示免费课程
		    已购买人数:已有***人购买
		    时间:2017/02/15 09:00 - 2017/02/15 12:00
		 
		    直播间观看人数
		    类型:点播(video),直播(live)
		    年级分类:小学一年级,高中三年级
		    科目分类:语文,数学
		3.4.2 在线购买接口:用来记录多少人购买
		    权限:登录用户
		    参数:课程id,分类(直播还是点播)
		    返回:支付宝交易字符串(urlencode后)
	3.5 课程收藏接口
		权限:登录用户
		参数:课程id,课程类型(直播还是点播)
		返回:是否收藏成功
	3.6 直播(点播)详情接口
		权限:全部
		参数:课程id,类型
		返回:除了列表中的那些字段外,增加:课程介绍,老师介绍,目录列表,是否已购买,是否已收藏
	3.7 课程评价列表
		权限:全部
		功能:该课程下的评价列表
		参数:分页参数,类型(直播还是点播课程),课程id
		返回:评价列表
	3.8 发布课程评价
		权限:登录用户
		参数:课程id,类型(直播还是点播),评价内容
		返回:是否评论成功
	3.9 直播点播搜索
		权限:全部
		参数:类型,分页参数,关键字
		返回:直播点播列表
4.个人中心
	4.1注册
		4.1.1注册接口
			权限:全部
			参数:手机号,密码,昵称,头像,验证码(获取如:4.1.2)
			返回:是否注册成功
		4.1.2手机验证码获取接口
			权限:全部
			参数:手机号
			返回:验证码
	4.2登录接口
		权限:全部
		参数:手机号,密码
		返回:用户id,任教班级,头像,昵称,手机号码
	4.3重新设置密码接口
		权限:全部
		参数:手机号,新密码,验证码(获取如:4.1.2)
		返回:是否修改成功
	
	4.5我的钱包接口
		权限:当前登录账号
		参数:分页
		返回:交易记录列表
	4.6我的课程接口
		权限:当前登录账号
		参数:无
		返回:已购买的课程列表
	4.7 我的收藏接口
		权限:登录用户
		参数:分页参数,是否已购买
		返回:课程列表
	4.8 需提醒的直播列表
		说明:直播前24小时和1小时需要消息提醒,所以要这个接口。返回的是已购买未开始的直播课程。
		权限:登录用户
		参数:无
		返回:相关课程列表(已购买并且未开始的直播课程)
	4.9 会员购买接口
		参数:无
		权限:登录用户
		返回:支付宝用的订单字符串
	5.10 昵称和头像修改接口
		参数:昵称,头像图片地址
		权限:登录用户
		返回:是否修改成功


	5.11 在线客服
		5.11.1 发布问题
			权限:登录用户
			参数:标题,内容
			返回:是否发布成功
		5.11.2 自己已发布的问题列表
			权限:登录用户
			参数:无(不分页)
			返回:问题列表(只返回自己发布的),返回标题,内容,发布时间,最后回复时间,回复数量,问题ID,问题下的回复数
		5.11.3 获取回复列表
			权限:登录用户
			参数:问题id
			返回:回复列表,数据:回复人昵称,回复人头像,回复时间,回复内容
		5.11.4 回复问题
			权限:登录用户
			参数:用户id(其实只有后台和自己能回复),问题ID,回复内容
			返回:是否成功

	5.12 获取最新版本
		权限:全部
		参数:类型(IOS还是android)
		返回:代码版本(int类型,用于判断版本),版本字符串(比如1.2.0,用于显示给用户看的,随便填),下载地址(string),更新内容(string)


	0315新加需求

	1.新闻搜索接口
	权限:全部
	参数:分页参数,关键字
	返回:新闻列表


	2.课程自定义价格付款接口:
	概述:用户想付多少就付多少,付了钱就能看
	权限:登录
	参数:价格(至少1元),课程id,课程类型
	返回:返回对应课程对应价格的支付宝订单字符串(注意订单也要唯一)

	3.新闻列表相关接口修改
		返回数据里增加字段判断是否是专题类型,增加专题图片数据(数组)

	2.推荐相关
		2.1 推荐人和邀请的人相关信息获取
		权限:登录
		参数:无
		返回:推荐人昵称,推荐人头像,我邀请的总人数
		2.2 提交我的推荐人
		权限:登录
		参数:推荐人账号
		返回:是否成功

		2.3 我邀请的人列表
		权限:登录
		参数:无
		返回:我邀请的人列表