某教育app接口文档.doc

前后端接口文档文档修改记录序号修改时间修改人修改内容创建基准版本目录文档说明该文档用于描述前后台各类接口明细包括用户注册用户登录用户信息获取等本文档适用阅读人群设计人员前端开发工程师服务端开发工程师接口说明接口采用方式提供前端使用请求接口接口返回采用对象传递后端服务返回至对象中格式如下对象名通用说明通用错误返回当接口请求处理出错时接口会返回通用的错误返回格式返回格式错误代码说明服务级错误为系统级错误服务模块代码具体错误代码错误代码对照表查看错误代码详细接口用户注册端账号注册请求请求方式是否需要登录否请求参数参数字段是否必选字段类型说明学生注册参数是账号类型学生家长老师是用户名是密码是手机号码否邮箱否邀请码否真实姓名否性别男女否生日否省份否城市否地区否学校名称否年级否希望辅导或答疑的科目家长注册参数是账号类型学生家长老师是用户名是密码是手机号码否邮箱否邀请码否真实姓名否家长身份否学生姓名否性别男女否生日否省份否城市否地区否学校名称否年级否希望辅导或答疑的科目老师注册参数是账号类型学生家长老师是用户名是密码是手机号码否邮箱否邀请码否真实姓名否性别男女否生日否省份否城市否地区否银行账号否所在学校名称否学历否擅长科目否教学经验否辅导年级否辅导科目否教师简介否获奖情况返回结果错误返回请详见通用错误返回正常返回字段如下返回字段字段类型说明成功跳转至页面并且中把用户对象写进去失败跳转到失败页面范例注意事项其他用户登录使用账户密码登录支持学生家长老师顾问请求请求方式是否需要登录否请求参数参数字段是否必选字段类型说明是账号名称是密码是学生家长老师顾问可选登录方式默认使用用户名用户名手机号码返回结果错误返回请详见通用错误返回正常返回字段如下返回字段字段类型说明成功返回到主页面失败返回到页面范例注意事项其他主页获取公告列表主页获取公告列表取表中字段为的记录注意主页返回按创建时间最新的前条数据请求请求方式是否需要登录否请求参数参数字段是否必选字段类型说明无返回结果错误返回请详见通用错误返回正常返回字段如下返回字段字段类型说明返回公告列表公告公告内容创建时间创建人是否过期范例注意事项其他主页获取活动列表获取活动列表取表中字段为的记录注意主页返回按创建时间最新的前条数据请求请求方式是否需要登录否请求参数参数字段是否必选字段类型说明无返回结果错误返回请详见通用错误返回正常返回字段如下返回字段字段类型说明活动列表活动信息活动内容创建时间创建者活动开始时间活动结束时间是否过期范例注意事项其他主页获取明星学员列表获取明星学员列表取辅导前分数与辅导后分数相差最大的学员列表暂时按用户取前面条记录在中一样最后一次考试记录与第一次考试记录分数相差的分数注意主页返回按相差分数最大的前条数据请求请求方式是否需要登录是请求参数参数字段是否必选字段类型说明否页数返回结果错误返回请详见通用错误返回正常返回字段如下返回字段字段类型说明学生学生名称所在学校辅导科目辅导前分数辅导后分数范例注意事项其他主页获取推荐老师列表获取推荐老师列表目前按注册时间倒序顺序选出前个从和中取数据注意主页返回按相差分数最大的前条数据请求请求方式是否需要登录是请求参数参数字段是否必选字段类型说明是页数从开始返回结果错误返回请详见通用错误返回正常返回字段如下返回字段字段类型说明推荐老师列表教师名称教师编号综合评价课程开始日期课程结束日期辅导开始时间辅导结束时间辅导科目辅导科目个人标签老师属性教学经验范例注意事项其他主页获取点金名师列表获取点金名师列表目前按注册时间倒序顺序选出前个从和中取数据注意主页返回按相差分数最大的前条数据请求请求方式是否需要登录是请求参数参数字段是否必选字段类型说明是页数返回结果错误返回请详见通用错误返回正常返回字段如下返回字段字段类型说明点金名师列表教师名称教师编号综合评价课程开始日期课程结束日期辅导开始时间辅导结束时间辅导科目辅导科目个人标签老师属性教学经验范例注意事项其他主页精彩课堂录像列表批量设置消息状态请求请求方式是否需要登录是请求参数参数字段是否必选字段类型说明是页数请求示例返回结果错误返回请详见通用错误返回正常返回字段如下返回字段字段类型说明主页精彩课堂录像列表课堂录像辅导课程或答疑课程录像主题录像类型播放时长学生老师录像画图点集语音文件创建时间范例注意事项其他通用代码操作是否成功代码代码含义成功非失败请看错误代码表错误代码系统级错误代码代码错误信息详细描述系统错误类似错误服务暂停处理超时非法请求该请求需要携带用户认证信息用户认证信息用户不可为空验证失败用户授权不可为空用户授权超期请求参数错误用户模块服务级错误代码代码错误信息详细描述注册需要用户提供手机号无效的手机号动态验证码错误用户名或密码错误