ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

Words

API	Description
GET api/words/getWordsCategory	查询所有单词分类
GET api/words/getWordsSubCategory?categoryId={categoryId}	查询单词子分类
GET api/words/getWords?categoryId={categoryId}&subcategoryId={subcategoryId}&studentId={studentId}	根据分类和子分类获取单词列表，答对3次以上不在出现
GET api/words/getStudyProgress?categoryId={categoryId}&studentId={studentId}	根据分类和子分类获取进度，答对算完成
POST api/words/saveStudyRecords	保存单词学习记录（支持单个和批量）
GET api/words/getCategoryInWords	查询单词类别
GET api/words/getAllSubcategory	查询所有绘本（homework）

Homework

API	Description
GET api/homework/getAll	查询所有作业
POST api/homework/searchWithPage	按条件分页查询
GET api/homework/getHomeworkDetailBySchoolClassId?classId={classId}	根据班级生成作业明细
GET api/homework/searchBookInfo?bookId={bookId}&hwType={hwType}	No documentation available.
GET api/homework/getHomeworkById?id={id}&isTeacher={isTeacher}&pageIndex={pageIndex}&pageSize={pageSize}	小程序端（根据当前用户Id(Teacher or Student)分页查询作业）
GET api/homework/getHomeworkAndDetailById?homeworkId={homeworkId}	主键Id查询作业
POST api/homework/saveHomeworkAndDetail	创建或修改作业
POST api/homework/saveHomework	保存作业(小程序端)
GET api/homework/deleteHomework?homeworkId={homeworkId}	删除作业
GET api/homework/getClassByTeacherAndDate?teacherId={teacherId}&classDate={classDate}	根据老师和日期查询当天已排课的班级

Student

API	Description
GET api/student/GetByPhone?phone={phone}	No documentation available.
GET api/student/GetStudentClassTime?studentId={studentId}	No documentation available.
GET api/student/GetStudentTimetable?studentId={studentId}&mode={mode}&wIndex={wIndex}	No documentation available.
GET api/student/getStudentClassRecordByCourseId?studentId={studentId}&courseId={courseId}&dateMode={dateMode}&pageIndex={pageIndex}&pageSize={pageSize}	查询学员某个课程的上课记录
GET api/Student	No documentation available.
GET api/Student/{id}	No documentation available.

AutoTask

API	Description
GET api/autoTask/SendCourseScheduleMsg?token={token}	发送上课提醒给学员（上课前一天晚上9:00发送）
GET api/autoTask/UploadSqlServerBackupFileToAliyunOss?token={token}	把sqlserver的备份文件上传到阿里云的OSS
GET api/autoTask/SenClassTimeMsg?token={token}&classTime={classTime}	发送剩余课次提醒.（课程剩余10次时发【课程剩余通知】；剩余2次时发【学费即将到期提醒】，每晚8点发送，）

CompanyCompetition

活动

API	Description
GET api/competition/getCompetition	查询进行中的活动
GET api/competition/getCompetitionById?competitionId={competitionId}	查询活动By ID
GET api/competition/getCompetitionDetail?competitionId={competitionId}&studentId={studentId}	获取活动详细资料
GET api/competition/getRankingList?competitionId={competitionId}	获取排行榜

Security

API	Description
GET api/Security/GetAccountInfo?openId={openId}	No documentation available.
GET api/Security/GetStudentByPhone?phone={phone}	No documentation available.
POST api/Security/Login	No documentation available.
POST api/Security/saveWxOpenId	No documentation available.
POST api/Security/BindPhone	No documentation available.
POST api/Security/SetDefault	No documentation available.
POST api/Security/UploadAvatar	No documentation available.

User

API	Description
POST user/login	登录
GET user/info?token={token}	根据token获取用户资料
POST user/searchUser	按条件分页查询用户
POST user/saveUser	新增或修改用户
GET user/deleteUser?userId={userId}	删除用户及分配至组中的用户
POST user/assignUserGroup	为用户分配角色
GET user/searchAllRoles	查询所有角色
POST user/searchRole	按条件分页查询角色
GET user/searchRoleByUserId?userId={userId}	根据用户Id查询角色
POST user/saveRole	新增或修改角色
GET user/deleteGroup?groupId={groupId}	删除角色及角色权限
POST user/assignGroupPermission	给角色分配权限
GET user/searchAllPermissions	查询所有权限
POST user/searchPermission	按条件分页查询权限
GET user/searchPermissionByGroupId?groupId={groupId}	根据角色Id查询权限
POST user/savePermission	新增或修改权限
GET user/deletePermission?permissionId={permissionId}	删除权限及分配到组中的权限

PictureBook

API	Description
POST api/pictureBook/searchWithPage	按条件分页查询
POST api/pictureBook/savePictureBook	No documentation available.
GET api/pictureBook/deletePictureBook?bookId={bookId}	删除绘本的所有资料
GET api/pictureBook/getBookByCategoryId?categoryId={categoryId}	根据类别查询绘本（绑定select控件）
GET api/pictureBook/getBookByCategoryIdWithPermission?studentId={studentId}&categoryId={categoryId}	根据类别查询绘本，带权限
GET api/pictureBook/getContentByBookId?bookId={bookId}	查询绘本的内容
GET api/pictureBook/getAllBook	查询所有绘本（homework）
GET api/PictureBook/{id}	主键BookId查询

Comm

API	Description
GET api/comm/GetMpSetting	No documentation available.
GET api/comm/GetIconList	No documentation available.
GET api/comm/GetSwiperList	No documentation available.

StudentLeave

学员请假

API	Description
GET api/studentLeave/getStudentLeaveRequest?studentId={studentId}&startDate={startDate}&endDate={endDate}	按日期查询学员的请假单
GET api/studentLeave/getStudentScheduleByDate?studentId={studentId}&requestDate={requestDate}	查询学员一天的上课安排
POST api/studentLeave/submitLeaveRequest	保存请假单

Teacher

API	Description
GET api/teacher/GetByPhone?phone={phone}	No documentation available.
GET api/teacher/GetTimetable?teacherId={teacherId}&mode={mode}&dIndex={dIndex}	No documentation available.
GET api/teacher/GetRollCallStudents?schoolClassId={schoolClassId}&courseScheduleId={courseScheduleId}&courseId={courseId}	No documentation available.
POST api/teacher/RollCall	No documentation available.
GET api/teacher/getActiveTecher	查询在职的老师
GET api/teacher/searchAttendStudent?courseScheduleId={courseScheduleId}	获取需打课堂表现分的学生
GET api/Teacher	No documentation available.
GET api/Teacher/{id}	No documentation available.
POST api/Teacher	No documentation available.
PUT api/Teacher	No documentation available.
DELETE api/Teacher/{id}	No documentation available.

SchoolClass

API	Description
GET api/schoolClass/getByTecherId?teacherId={teacherId}	根据老师查询有效班级
GET api/schoolClass/getStudentByClassId?classId={classId}	查询班级中的学生

StudentSignIn

API	Description
GET api/studentSignIn/GetStudents	No documentation available.
POST api/studentSignIn/CheckHomework	No documentation available.
POST api/studentSignIn/SignIn	No documentation available.
POST api/studentSignIn/StudengLeave	No documentation available.
POST api/studentSignIn/TeacherSignIn	No documentation available.

Membership

API	Description
GET api/membership/getAward	查询所有可兑换的礼品
GET api/membership/getMembershipPoint?memberShipId={memberShipId}	查询学员的可用积分
GET api/membership/getRewardLog?memberShipId={memberShipId}&pageIndex={pageIndex}&pageSize={pageSize}	查询所有积分记录
GET api/membership/getRewardExchangeLog?memberShipId={memberShipId}&pageIndex={pageIndex}&pageSize={pageSize}	查询学员的兑换记录
POST api/membership/exchangeAward	兑换奖品
POST api/membership/searchWithPage	按条件分页查询奖品
POST api/membership/saveAward	添加或修改奖品
GET api/membership/deleteAward?awardId={awardId}	删除奖品
POST api/membership/calssScore	课堂表现评分
POST api/membership/getAllRewardExchangeLog	查询所有兑换记录
POST api/membership/handleExchangeAward	后台标记奖品实物已发放
GET api/membership/searchExchangeLog?awardId={awardId}	查询奖品的兑换记录
POST api/membership/searchMembershipRewardWithPage	按条件分页查询积分
POST api/membership/handleMembershipStatus	设置学员积分状态
GET api/membership/getScoreboard	查询积分榜前20
POST api/Membership?membershipId={membershipId}&point={point}	更新学员积分

WeChat

API	Description
POST api/wx/CreateMenu	No documentation available.

TextBook

API	Description
POST api/textBook/searchWithPage	按条件分页查询
POST api/textBook/saveTextBook	新增或修改课本
POST api/textBook/saveTextBookChapter	添加章节
POST api/textBook/assignPermision	保存权限
GET api/textBook/deleteTextBook?bookId={bookId}	删除课本的所有资料
GET api/textBook/deleteTextBookChapter?bookId={bookId}&chapterId={chapterId}	删除课本章节
GET api/textBook/searchPermissions?bookId={bookId}	根据课本ID查询已分配和待分配的学生和老师
GET api/textBook/getBookWithInChapterItem	查询有内容的课本
GET api/textBook/getTextBookChapter?bookId={bookId}&studentId={studentId}	根据book Id查询章节,studentId查章节权限
GET api/textBook/getChapterByBookId?bookId={bookId}	根据bookId查询章节
GET api/textBook/getTextBookContent?bookId={bookId}&chapterId={chapterId}&chapterItemId={chapterItemId}	查询书本章节内容
GET api/textBook/getChapterItem?bookId={bookId}&chapterId={chapterId}	查询章节的Item
POST api/textBook/saveRecord	保存学生的测评得分记录
GET api/TextBook	查询所有课本
GET api/TextBook/{id}	主键BookId查询
POST api/TextBook?hearingIndc={hearingIndc}	查询所有课本

Examination

API	Description
GET api/examination/getAllBankCategory	查询所有题库分类
POST api/examination/saveQuestionBankCategory	创建或修改题库分类
GET api/examination/deleteQuestionBankCategory?categoryId={categoryId}	删除题库分类
POST api/examination/searchBankWithPage	按条件分页查询题库
POST api/examination/saveQuestionBank	创建或修改题库
GET api/examination/deleteQuestionBank?questionBankId={questionBankId}	删除题库
GET api/examination/searchQuestionByBankId?questionBankId={questionBankId}	查询题库中所有的题目
POST api/examination/saveQuestion	录入或修改题目
GET api/examination/deleteQuestion?questionId={questionId}	删除题目
GET api/examination/getAllPaperCategory	查询所有试卷分类
POST api/examination/savePaperCategory	创建或修改试卷分类
GET api/examination/deletePaperCategory?categoryId={categoryId}	删除试卷分类
POST api/examination/searchPaperWithPage	按条件分页查询试卷
POST api/examination/savePaper	创建或修改试卷
GET api/examination/deletePaper?paperId={paperId}	删除题库

PictureBookCategory

API	Description
GET api/prictureBookCategory/getAllCategory	No documentation available.
POST api/prictureBookCategory/searchWithPage	按条件分页查询绘本类别
POST api/prictureBookCategory/saveCategory	新增或修改绘本类别
GET api/prictureBookCategory/deleteCategory?categoryId={categoryId}	删除绘本类别
GET api/prictureBookCategory/getCategoryInBook	查询绘本类别（有绘本的）
GET api/prictureBookCategory/getBookCategoryWithPermission?studentId={studentId}	查询所有绘本类别,带权限
GET api/PictureBookCategory/{id}	No documentation available.

WxTemplateMessage

API	Description
GET api/WxTemplateMessage	No documentation available.
GET api/WxTemplateMessage/{id}	No documentation available.
POST api/WxTemplateMessage	No documentation available.
PUT api/WxTemplateMessage/{id}	No documentation available.
DELETE api/WxTemplateMessage/{id}	No documentation available.

PictureBookStudentRecord

API	Description
GET api/PictureBookStudentRecord	No documentation available.
GET api/PictureBookStudentRecord?bookId={bookId}&studentId={studentId}	No documentation available.
POST api/PictureBookStudentRecord	保存绘本阅读记录，完成作业
POST api/PictureBookStudentRecord?studentId={studentId}&point={point}&rewardType={rewardType}&refId={refId}	No documentation available.
PUT api/PictureBookStudentRecord/{id}	No documentation available.
DELETE api/PictureBookStudentRecord?bookId={bookId}&studentId={studentId}	No documentation available.

WorksRankingList

API	Description
GET api/WorksRankingList	No documentation available.
POST api/WorksRankingList	No documentation available.
PUT api/WorksRankingList	No documentation available.
DELETE api/WorksRankingList/{id}	No documentation available.