| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Agent.Agent.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Agent.Agent.Add | 新增代理商 | 新增代理商 |
| 3 | Agent.Agent.Show | 查看代理商详情 | 查看代理商详情 |
| 4 | Agent.Agent.Remove | 移除代理商 | 移除代理商 |
| 5 | Agent.Agent.SetStatus | 激活,关闭代理商 | 激活,关闭代理商 |
| 6 | Agent.Agent.Index | 代理商进来的首页数据 | 代理商的首页数据 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Agent.AgentCommission.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Agent.AgentCommission.Show | 查看代理商详情 | 查看代理商详情 |
| 3 | Agent.AgentCommission.SetCash | 获取代理图表数据 | 获取代理图表数据 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Agent.AgentDayMonth.List | 添加代理每月的默认数据 | 添加代理每月的默认数据 |
| 2 | Agent.AgentDayMonth.OrganList | 添加机构每月的默认数据 | 添加机构每月的默认数据 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Agent.City.List | 获取列表 | 获取列表,只根据父id查询 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Agent.Company.List | 添加机构管理员 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Dm.Upload.ToOss | 上传文件到oss | 上传文件到oss |
| 2 | Dm.Upload.Excel | 上传并解析Excel | 上传并解析Excel |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.AppEvaluation.Evaluation | 天赋测评数据 | 天赋测评数据 |
| 2 | Ultima.AppEvaluation.AIAnswer | AI获取测评文字 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.Classes.CourseType | 获取课程信息 | 获取课程信息(正式课、体验课...) |
| 2 | Ultima.Classes.TeamList | 获取(战队)班级列表 | 获取(战队)班级列表 |
| 3 | Ultima.Classes.SetTeam | 创建/修改(战队)班级 | 创建/修改(战队)班级 |
| 4 | Ultima.Classes.CheckOrg | 老师选择上课机构 | 当老师有多个所属机构的时候，要老师来确认具体上课的机构 |
| 5 | Ultima.Classes.SearchTeacher | 扫码登录选择上课的老师 | 当登录为扫码登录时，需要选择是哪个老师在上课/手机号姓名模糊匹配 |
| 6 | Ultima.Classes.RandName | 随机team名称 | 随机team名称 |
| 7 | Ultima.Classes.SearchUser | 搜索学生 | 搜索学生,按姓名、昵称、手机号模糊匹配 |
| 8 | Ultima.Classes.Prepare | 准备上课 | 准备上课,team_id:战队（班级)id.必须,phone:老师手机号 （教室扫码的情况下必传） |
| 9 | Ultima.Classes.SetAbilities | 设置学员战力值（批量） | 设置学员战力值（批量） |
| 10 | Ultima.Classes.Rooms | 获取老师登陆后创建战队需要选择上课的教室 | 获取老师登陆后创建战队需要选择上课的教室 |
| 11 | Ultima.Classes.BindingPianos | 绑定/解绑钢琴 | 绑定/解绑钢琴 |
| 12 | Ultima.Classes.AddPianos | 新增钢琴 | 新增钢琴 |
| 13 | Ultima.Classes.RecordCards | 卡牌错题记录 | 记录卡牌错题 |
| 14 | Ultima.Classes.SetCourseId | 设定测试课程id | 设定测试课程id |
| 15 | Ultima.Classes.CourseList | 课程列表 | 获取所有课程列表 |
| 16 | Ultima.Classes.Start | 开始上课 | 开始上课 |
| 17 | Ultima.Classes.Record | 记录上课（游戏）结果 | 记录结果 |
| 18 | Ultima.Classes.Finish | //请检测函数注释 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.FreeTraining.GetTextbooks | 获取自由练习书目列表 | 获取自由练习书目列表 |
| 2 | Ultima.FreeTraining.GetSongs | 获取书目对应的曲目 | 根据书目id,获取对应书目下的所以曲目 |
| 3 | Ultima.FreeTraining.GetSongContents | 获取曲目里的内容 | 根据曲目id,获取对应曲目下内容 |
| 4 | Ultima.FreeTraining.SaveFreeTraining | 保存自由练习成绩 | 记录学员每次完成自由练习的成绩 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.Home.Tipcase | 首页默认提示弹框 | 首次开机默认提示框 |
| 2 | Ultima.Home.Config | //请检测函数注释 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.Job.ParseSubjectsMXL | //请检测函数注释 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.Login.Login | 教师账号登录 | 教师账号登录返回token信息和所属机构 |
| 2 | Ultima.Login.ScanLogin | 教室二维码登录 | 二维码登录 code值为room_number |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.Milestone.GetMilestoneGames | 获取里程碑游戏 | 根据学员的闯关，系统陆续开放后续的游戏 |
| 2 | Ultima.Milestone.GetMilestones | 获取里程碑列表 | 根据游戏类型获取对应游戏的定位赛，目前只需quick（快速音）游戏定位即可 |
| 3 | Ultima.Milestone.ClaimBox | 领取里程碑宝箱 | 领取里程碑宝箱，如果指定游戏，则一次性领取同一游戏下所有的宝箱、如果指定关卡，则领取单关卡的宝箱 |
| 4 | Ultima.Milestone.GetMilestoneContents | 获取里程碑内容 | 根据任务id,获取里程碑内容数据 |
| 5 | Ultima.Milestone.SaveUserMilestone | 保存里程碑成绩 | 记录学员每次完成里程碑的成绩 |
| 6 | Ultima.Milestone.LocateMilestone | 定位里程碑 | 获取解锁里程碑关卡游戏数据 |
| 7 | Ultima.Milestone.AddLocateMilestone | 保存定位里程碑 | 保存里程碑关卡游戏数据 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.Personal.Personal | 获取个人信息 | 获取个人信息 |
| 2 | Ultima.Personal.EditProfile | 编辑个人信息 | 老师登录编辑个人信息 |
| 3 | Ultima.Personal.Logout | 退出登录 | 退出登录 |
| 4 | Ultima.Personal.Record | 上课记录 | 老师上课记录 |
| 5 | Ultima.Personal.PianoRoom | 钢琴教室 | 教室绑定的钢琴列表 |
| 6 | Ultima.Personal.SavePhone | 修改手机号 | 老师更改手机号信息 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.Score.Download | 成绩排名 | 成绩排名 |
| 2 | Ultima.Score.GroupScore | 以接口方式获取战队/个人排名 | 战队及个人排名 |
| 3 | Ultima.Score.GroupScoreFS | 入围决赛战队 | 如果决赛战队 |
| 4 | Ultima.Score.UsersScoreFS | 个人复赛排名 | 个人复赛排名 |
| 5 | Ultima.Score.GroupScoreSQ | 四强赛战绩 | 四强赛战绩 |
| 6 | Ultima.Score.GroupScoreJS | 总决赛战绩（冠军赛） | 总决赛战绩 |
| 7 | Ultima.Score.QuickSQ | 根据复赛排名自动生成四强赛战队 | 生成四强赛战队 |
| 8 | Ultima.Score.QuickJS | 根据四强赛成绩快速生成决赛战队 | 生成决赛战队 |
| 9 | Ultima.Score.Table | 热身赛 | 热身赛 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.User.UserInfo | 获取学员信息 | 试试刷新学员信息 |
| 2 | Ultima.User.SaveDefPet | 更新默认选中的宠物 | 修改默认选中的宠物 |
| 3 | Ultima.User.GetUserMilestoneAbilitys | 获取学员里程碑战力 | 获取学员里程碑战力 |
| 4 | Ultima.User.OpenPetEgg | 开启新宠物蛋 | 购买新的宠物蛋，系统随机分配 |
| 5 | Ultima.User.HatchPetEgg | 进化宠物蛋-选择性别 | 孵化宠物蛋时选择性别，系统根据概率随机确认是否要激活稀有形态的宠物 |
| 6 | Ultima.User.PetEvolve | 确认进化宠物 | 确认进化宠物，需选择宠物性别 |
| 7 | Ultima.User.SavePetNickname | 更新宠物昵称 | 更新宠物昵称 |
| 8 | Ultima.User.Save | 更新学员 | 更新学员，目前手机号可以重复（验证手机号+姓名），带token只有编辑功能。 |
| 9 | Ultima.User.SwitchLogin | 更换学员登录 | 更换学员登录（同一个手机号可能有多个学员），该接口是为了切换学员信息 |
| 10 | Ultima.User.SavePassword | 更新密码 | 更新密码 |
| 11 | Ultima.User.SaveAvatar | 更新学员头像 | 提供头像地址，替换学员头像 |
| 12 | Ultima.User.UploadUserAvatar | 上传学员头像 | 上传学员头像文件到服务器本地，并将上传纪录存在数据库。默认可上传任何类型的文件，可通过修改接口参数配置限制文件类型。 |
| 13 | Ultima.User.AbilityRanking | 战力排名榜 | 学员战力排名榜 |
| 14 | Ultima.User.WeeklyRanking | 周赛排名榜 | 学员周赛排名榜 |
| 15 | Ultima.User.OpenWeeklyBox | 领取周赛宝箱 | 领取周赛宝箱，每周根据排名奖励对应的金币和进化石 |
| 16 | Ultima.User.FightRanking | 排位赛排名榜 | 学员排位赛排名榜 |
| 17 | Ultima.User.OpenTalentEval | 学员开启天赋测评 | 学员开启天赋测评 |
| 18 | Ultima.User.SaveTalentEval | 保存学员天赋测评数据 | 保存学员天赋测评数据 |
| 19 | Ultima.User.Logout | 退出登录 | 退出登录 |
| 20 | Ultima.User.Remove | 学员注销 | 学员注销 |
| 21 | Ultima.User.Pets | 宠物图鉴：6个宠物列表 | 6大宠物 |
| 22 | Ultima.User.UserPets | 宠物图鉴：进化阶段和皮肤 | 所指定宠物各个不同皮肤的各个进化阶段的列表（包括已解锁的和未解锁的） |
| 23 | Ultima.User.SaveUserOnlineLog | 记录学员在线时长 | 记录学员在线时长日志 |
| 24 | Ultima.User.MainCourseUsers | 获取今日主课学员列表 | 今日主课学员列表 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.UserFight.GetLocate | 获取排位定位局题库 | 根据游戏类型获取对应游戏的定位赛，目前只需quick（快速音）游戏定位即可 |
| 2 | Ultima.UserFight.SaveLocate | 更新排位赛定位局数据 | 定位局结束后，更新学员排位赛相关数据 |
| 3 | Ultima.UserFight.Lineup | 排位赛-排队 | 排队等待匹配排位赛 |
| 4 | Ultima.UserFight.MatchUserFight | 排位赛 - 获取匹配结果 | 获取排位赛匹配结果 |
| 5 | Ultima.UserFight.GetRoomNo | 匹配成功后，获取房间号 | 匹配成功后，获取房间号 |
| 6 | Ultima.UserFight.FightGameOver | 结束游戏 | 【socket专用】此处仅为测试开放 |
| 7 | Ultima.UserFight.FightUseEnergy | 排位赛使用能量块避免掉级 | 排位赛使用能量块抵扣避免掉级 |
| 8 | Ultima.UserFight.GetFightSubjects | 排位赛 - 获取排位题库 | 获取排位题库 - 【socket专用】此处仅为测试开放 |
| 9 | Ultima.UserFight.GetFightUserInfo | 获取排队用户信息 | 获取排队用户信息 |
| 10 | Ultima.UserFight.RemoveLineupQueue | 移除排位 | 取消排位 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.UserLogin.Login | 学员账号登录 | 学员账号登录返回token信息和关联的学员组 |
| 2 | Ultima.UserLogin.GetVerifiCode | 获取验证码 | 获取验证码 |
| 3 | Ultima.UserLogin.AuthorizeLogin | 授权登录 | iPad使用授权登录 |
| 4 | Ultima.UserLogin.AuthorizeRegister | 授权注册 | 当授权登录失败后，便须注册后自动登录，之后再使用授权登录 |
| 5 | Ultima.UserLogin.SaveUserAbilitys | 批量同步学员战力 | 可能临时新增战力项，老学员没有战力，需要跑此接口生成 |
| 6 | Ultima.UserLogin.SaveUserPetAbilitys | 自动补齐宠物战力 | 可能临时新增战力项，原宠物没有数据，需要跑此接口生成 |
| 7 | Ultima.UserLogin.SaveUserPetMarkUp | 更新学员宠物对应的战力加成 | 更新学员宠物的战力加成，同时根据学员战力同步宠物对应的战力值 |
| 8 | Ultima.UserLogin.SaveUserPetBattleByTop5 | 更新学员上阵的宠物 | 批量更新学员上阵的宠物 |
| 9 | Ultima.UserLogin.SaveUserCurTaskNo | 更新学员每项战力当前最高等级 | 更新学员每项战力当前解锁的最高等级 |
| 10 | Ultima.UserLogin.SyncUserMaintaskNo | 同步学员主线任务进度 | 同步学员主线任务课程进度 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.UserPet.RestorePet | 重塑宠物 | 重置宠物，系统将按比例返回宠物历史消耗的进化石和金币。 |
| 2 | Ultima.UserPet.DevourPet | 【作废】吞噬宠物，该接口不用了 | 吞噬同类（已被重置或零基础）宠物可以进化自己的等级 |
| 3 | Ultima.UserPet.EvolvePet | 进化宠物 | 进化宠物，根据系统设定满足战力值达标、进化石和所需吞噬的宠物足够则可以进化 |
| 4 | Ultima.UserPet.LogoutPet | 放生宠物 | 放生宠物，系统将按比例返回宠物历史消耗的进化石和金币。 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.UserStarTask.StarTask | 获取星球任务相关数据 | 获取学员当前任务相关数据：周任务完成情况、今日任务在线时长、宝箱是否开启 |
| 2 | Ultima.UserStarTask.GetStarTasks | 获取星球任务列表 | 获取星球任务列表 |
| 3 | Ultima.UserStarTask.GetStarTaskBySongId | 获取书目对应的星球任务 | 获取书目对应的星球任务 |
| 4 | Ultima.UserStarTask.OpenStarTaskBox | 开启星球周任务宝箱 | 系统查出学员最近完成的作业，开启星球周任务宝箱时，计算当前作业的平均成绩，给予不同奖励 |
| 5 | Ultima.UserStarTask.AddUserStarTask | 保存星球任务成绩 | 记录学员每次完成星球任务的成绩 |
| 6 | Ultima.UserStarTask.GetEverydayTask | 获取每日任务数据 | 系统自动根据每个学员的里程碑关卡，推送每日任务的数据 |
| 7 | Ultima.UserStarTask.SaveEverydayTask | 记录每日任务成绩 | 要记录学员每次完成今日任务的成绩 |
| 8 | Ultima.UserStarTask.OpenEverydayTaskBox | 开启今日任务宝箱 | 开启今日任务宝箱 |
| 9 | Ultima.UserStarTask.GetMainTask | 获取主线任务数据 | 系统自动根据每个学员的上课进入，推送主线任务的数据 |
| 10 | Ultima.UserStarTask.SaveMainTask | 记录主线任务成绩 | 要记录学员每次完成主线任务的成绩 |
| 11 | Ultima.UserStarTask.OpenMainTaskBox | 领取主线任务奖励 | 领取主线任务奖励 |
| 12 | Ultima.UserStarTask.RemoveEverydayTask | 移除学员今日任务缓存 | 移除指定学员每日任务缓存，系统会重新生成题库。如果不指定uid，则系统会清除所有今日任务缓存 |
| 13 | Ultima.UserStarTask.GetDailyTasks | 【作废】获取今日任务 | 【作废】今日任务系统根据学员里程碑的真实能力，自动推送题库 |
| 14 | Ultima.UserStarTask.OpenDailyDrillBox | 【作废】开启今日任务宝箱 | 【作废】开启今日任务宝箱 |
| 15 | Ultima.UserStarTask.RecordDailyDrillDuration | 【作废】记录学员日常练习在线时长 | 记录学员日常练习在线时长 |
| 16 | Ultima.UserStarTask.GetUserDailyDrill | 【作废】获取当前学员日常在线时长 | 获取当前学员日常在线时长 |
| 17 | Ultima.UserStarTask.RemoveUserDailyDrill | 【作废】移除当前学员日常在线时长 | 移除当前学员日常在线时长 |
| 18 | Ultima.UserStarTask.SaveUserFeedback | 保存学员意见反馈 | 学员在完成作业时，发生异常可以提交慈意见反馈便于查询 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Ultima.XfXh.Send | //请检测函数注释 | //请使用@desc 注释 |
| 2 | Ultima.XfXh.UserPets | //请检测函数注释 | //请使用@desc 注释 |
| 3 | Ultima.XfXh.Idms | //请检测函数注释 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Dmcrm.DingtalkLogin.GetAccessToken | 获取企业内部应用的accessToken | 企业内部应用调用本接口获取accessToken。调用服务端API获取应用资源时，需要通过accessToken来鉴权调用者身份进行授权。 |
| 2 | Dmcrm.DingtalkLogin.SsoUserInfo | 获取应用管理后台免登的用户信息 | 在应用管理后台免登场景中，需要本接口通过获取到的免登授权码code和获取到的应用后台免登的access_token来换取应用管理员的身份信息。 |
| 3 | Dmcrm.DingtalkLogin.AuthorizeLogin | 钉钉应用打开，老师自动登录 | 通过钉钉授权，老师自动登录 |
| 4 | Dmcrm.DingtalkLogin.OAuthorizeLogin | 钉钉老接口获取老师信息 | 通过钉钉授权，老师自动登录 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Dmcrm.FreeTraining.GetTextbooks | 获取自由练习书目列表 | 获取自由练习书目列表 |
| 2 | Dmcrm.FreeTraining.GetSongDetail | 获取曲谱明细 | 根据曲谱id 获取曲谱的明细 |
| 3 | Dmcrm.FreeTraining.GetSongSteps | 获取曲谱步骤 | 根据曲谱id 获取曲谱拆解的方案和步骤 |
| 4 | Dmcrm.FreeTraining.GetSongs | 获取书目对应的曲目 | 根据书目id,获取对应书目下的所以曲目 |
| 5 | Dmcrm.FreeTraining.GetSpeeds | 获取书目所有曲目的速度 | 根据书目id,获取对应书目下所有曲目的速度 |
| 6 | Dmcrm.FreeTraining.UpdSongStepDefaultPlanId | 替换曲谱默认方案 | 替换曲谱对应的默认方案 |
| 7 | Dmcrm.FreeTraining.SaveFreeTrainingSongPlan | 更新自由练习方案 | 教研老师在后台，保存/更新自由练习方案 |
| 8 | Dmcrm.FreeTraining.SaveFreeTrainingSongStep | 更新自由练习步骤 | 教研老师在后台，保存/更新自由练习步骤操作 |
| 9 | Dmcrm.FreeTraining.RemoveSongStep | 删除曲谱步骤 | 删除指定的曲谱步骤 |
| 10 | Dmcrm.FreeTraining.AutoCreateSongStep | 【脚本】自动生成曲谱步骤 | 系统自动生成曲谱步骤 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Dmcrm.Teacher.Datastatis | 老师相关数据统计 | 统计分析老师：薪资、绩点、转介绍、vip转化率、回课率 |
| 2 | Dmcrm.Teacher.GetUsers | 获取学员列表 | 返回所有的学员 |
| 3 | Dmcrm.Teacher.GetHomeworkBooks | 课后作业所有教材 | 课后作业所有教材 |
| 4 | Dmcrm.Teacher.GetHomeworkSongs | 课后作业对应教材的曲目 | 获取课后作业对应教材的曲目 |
| 5 | Dmcrm.Teacher.GetAttendCourses | 获取老师近几天课程 | 获取老师近几天课程 |
| 6 | Dmcrm.Teacher.ConfirmCoursed | 确认已上课课时 | 确认已上课课时 |
| 7 | Dmcrm.Teacher.SaveHomeworkUsers | 布置作业 | 保存/更新学员课后作业 |
| 8 | Dmcrm.Teacher.GetAttendCourseUser | 获取近几天上课的学员 | 获取近几天上课的学员 |
| 9 | Dmcrm.Teacher.GetUserHomeworkLog | 获取学员课后作业日志 | 获取学员课后作业日志 |
| 10 | Dmcrm.Teacher.SaveUserAppDueDate | 更新学员到期日期 | 更新学员到期日期 |
| 11 | Dmcrm.Teacher.BatchSaveUserDates | 批量更新学员到期日期 | 批量更新学员到期日期 |
| 12 | Dmcrm.Teacher.Logout | 老师退出 | 老师退出 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Dmcrm.TeacherLogin.Login | 老师账户登录 | 老师账户登录 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Organ.City.List | 获取列表 | 获取列表,只根据父id查询 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Organ.Classroom.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Organ.Classroom.Add | 新增 | 新增 |
| 3 | Organ.Classroom.Show | 查看详情 | 查看详情 |
| 4 | Organ.Classroom.Remove | 移除 | 移除 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Organ.Info.GetOrgAccount | 获取机构账户 | //请使用@desc 注释 |
| 2 | Organ.Info.GetOrg | 根据老师手机号 获取机构信息和机构学生 | //请使用@desc 注释 |
| 3 | Organ.Info.CheckPwd | 根据老师输入的密码验证 | 这是个临时接口，冻结金额逻辑并不严谨。实际则要更加严谨一些 |
| 4 | Organ.Info.DeductOrganAmount | 结束课程时，扣除机构余额 | 这是个临时接口，冻结金额并不严谨。 |
| 5 | Organ.Info.UpdUserByUid | 更新学员的uid | //请使用@desc 注释 |
| 6 | Organ.Info.GetUsersByUids | 根据uids组查询学员列表 | //请使用@desc 注释 |
| 7 | Organ.Info.SyncUsersByUidOrTel | 同步学员数据 | 提供学员的uid 或 手机号，系统将自动同步数据到其他平台 |
| 8 | Organ.Info.SyncUserfAbility | //请检测函数注释 | //请使用@desc 注释 |
| 9 | Organ.Info.LargeClass | 获取bm 课程 large_classes数据 | 获取 bm_large_classes数据 |
| 10 | Organ.Info.Region | //请检测函数注释 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Organ.Organ.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Organ.Organ.Add | 新增 | 新增 |
| 3 | Organ.Organ.Show | 查看详情 | 查看详情 |
| 4 | Organ.Organ.Remove | 移除 | 移除 |
| 5 | Organ.Organ.CostLogs | 机构余额日志 | 查看机构余额变更日志 |
| 6 | Organ.Organ.SetOrganBalance | 运营人员设置机构余额 | 运营人员设置机构余额 |
| 7 | Organ.Organ.ExportEval | 运营人员导出机构用户测评报告 | 运营人员导出机构用户测评报告 |
| 8 | Organ.Organ.DownloadExcel | @throws \PhpOffice\PhpSpreadsheet\Writer\Exception | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Organ.Piano.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Organ.Piano.Add | 新增 | 新增 |
| 3 | Organ.Piano.Show | 查看详情 | 查看详情 |
| 4 | Organ.Piano.Remove | 移除 | 移除 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Organ.Student.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Organ.Student.Add | 新增学员 | 新增学员，目前手机号可以重复（验证手机号+姓名）。 |
| 3 | Organ.Student.Show | 查看详情 | 查看详情 |
| 4 | Organ.Student.Remove | 移除 | 移除 |
| 5 | Organ.Student.GetMaterials | 获取教材 | 获取教材 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Organ.TbTeacher.Add | 新增 | 新增 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Organ.Teacher.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Organ.Teacher.Add | 新增 | 新增 |
| 3 | Organ.Teacher.Show | 查看详情 | 查看详情 |
| 4 | Organ.Teacher.Remove | 移除 | 移除 |
| 5 | Organ.Teacher.SyncUltima | 同步老师身份 | 根据dmcrm系统老师数据，同步标记究极院app老师身份 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pay.OnlinePay.WebPay | 机构充值 | 支付 |
| 2 | Pay.OnlinePay.OrderPay | 订单支付 | 支付 |
| 3 | Pay.OnlinePay.Refund | 订单退款 | 订单退款 |
| 4 | Pay.OnlinePay.Notify | 支付回调 | 支付 |
| 5 | Pay.OnlinePay.OrderPayNotify | 支付回调 | 支付 |
| 6 | Pay.OnlinePay.XbWebPay | 机构充值 | 支付 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pay.PayNotify.OrderPayNotify | 支付回调 | 支付 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.Accompany.Lists | 背景音乐列表 | 背景音乐列表 |
| 2 | Pf.Accompany.Add | 添加背景音乐 | 添加背景音乐 |
| 3 | Pf.Accompany.Show | 查看伴奏详情 | 查看伴奏详情 |
| 4 | Pf.Accompany.Delete | 删除背景音乐 | 删除背景音乐 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.Chapters.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Pf.Chapters.Add | 新增章节 | 新增章节 |
| 3 | Pf.Chapters.Show | 查看章节 | 查看章节 |
| 4 | Pf.Chapters.Remove | 删除章节 | 删除章节 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.Content.List | 分页获取列表 | 分页获取列表 |
| 2 | Pf.Content.Add | 新增知识点 | 新增知识点 |
| 3 | Pf.Content.Show | 查看知识点详情 | 查看知识点详情 |
| 4 | Pf.Content.Remove | 移除知识点 | 移除知识点 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.KlRanks.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Pf.KlRanks.Ranks | 所有阶位 | 所有阶位 |
| 3 | Pf.KlRanks.Add | 新增知识点阶位 | 新增知识点阶位 |
| 4 | Pf.KlRanks.Show | 查看知识点阶位详情 | 查看知识点阶位详情 |
| 5 | Pf.KlRanks.Remove | 移除知识点阶位 | 移除知识点阶位 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.KlType.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Pf.KlType.DgModuleList | 根据游戏递归数据 | 根据游戏递归数据 |
| 3 | Pf.KlType.DgList | 递归数据 | 递归数据 |
| 4 | Pf.KlType.Add | 新增知识点类型 | 新增知识点类型 |
| 5 | Pf.KlType.Show | 查看知识点类型详情 | 查看知识点类型详情 |
| 6 | Pf.KlType.Remove | 移除知识点类型 | 移除知识点类型 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.Knowledge.List | 分页获取列表 | 分页获取列表，支持关键字搜索,所属模块搜索,类型搜索 |
| 2 | Pf.Knowledge.Add | 新增知识点 | 新增知识点 |
| 3 | Pf.Knowledge.Show | 查看知识点详情 | 查看知识点详情 |
| 4 | Pf.Knowledge.Remove | 移除知识点 | 移除知识点 |
| 5 | Pf.Knowledge.Subjects | 根据知识点获取对应的题库 | 根据知识点获取题库 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.LargeClasses.List | 分页获取列表 | 分页获取列表，支持关键字搜索,所属模块搜索,类型搜索 |
| 2 | Pf.LargeClasses.Add | 新增课程管理 | 新增课程管理 |
| 3 | Pf.LargeClasses.Show | 查看课程管理 | 查看课程管理 |
| 4 | Pf.LargeClasses.Remove | 移除课程管理 | 移除课程管理 |
| 5 | Pf.LargeClasses.FindRankId | 选择课程管理，返回rank_id | 选择课程管理，返回rank_id |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.LcChapters.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Pf.LcChapters.Add | 新增课程章节 | 新增课程章节 |
| 3 | Pf.LcChapters.Show | 查看课程章节详情 | 查看课程章节详情 |
| 4 | Pf.LcChapters.Remove | 移除课程章节 | 移除课程章节 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.LcModules.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Pf.LcModules.ListGames | 分页获取游戏列表 | 分页获取游戏列表 |
| 3 | Pf.LcModules.Games | 获取所有游戏 | 获取所有游戏 |
| 4 | Pf.LcModules.Add | 新增大班课模块 | 新增大班课模块 |
| 5 | Pf.LcModules.Show | 查看大班课模块详情 | 查看大班课模块详情 |
| 6 | Pf.LcModules.Remove | 移除大班课模块 | 移除大班课模块 |
| 7 | Pf.LcModules.Knowledge | 根据模块id获取对应的知识点 | 根据模块id获取对应的知识点 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.LcScore.ListScore | 分页战力分获取列表 | 分页战力分获取列表 |
| 2 | Pf.LcScore.ExcelScore | 上传ExcelScore文件,更新战力分 | 上传ExcelScore文件,更新战力分 |
| 3 | Pf.LcScore.ListLargeClass | 分页课程战力分获取列表 | 分页课程战力分获取列表 |
| 4 | Pf.LcScore.ExcelLargeClass | 上传ExcelScore文件,更新课程分 | 上传ExcelScore文件,更新课程分 |
| 5 | Pf.LcScore.ExcelKlType | 上传ExcelKlType文件,导入知识链 | 上传ExcelKlType文件,导入知识链 |
| 6 | Pf.LcScore.ExcelKnowledge | 上传ExcelKnowledge文件,导入知识图谱 | 上传ExcelKnowledge文件,导入知识图谱 |
| 7 | Pf.LcScore.ExcelRank | 上传ExcelRank文件,导入阶位 | 上传ExcelRank文件,导入阶位 |
| 8 | Pf.LcScore.ExcelContent | 上传ExcelContent文件,导入课程内容 | 上传ExcelContent文件,导入课程内容,视奏大作战不支持批量导入 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.Pets.Add | 添加宠物 | 添加宠物 |
| 2 | Pf.Pets.Show | 查看详情 | 查看详情 |
| 3 | Pf.Pets.List | 宠物列表 | 用户宠物列表 |
| 4 | Pf.Pets.Remove | 用户宠物移除 | 用户宠物移除 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.Preview.List | 获取课程内容 | 获取课程内容 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.SightSubject.List | 分页获取列表 | 分页获取列表，支持关键字搜索 |
| 2 | Pf.SightSubject.Add | 添加视奏练习题 | 添加视奏练习题 |
| 3 | Pf.SightSubject.Detail | 视奏练习题详情 | 视奏练习题详情 |
| 4 | Pf.SightSubject.Remove | 删除视奏练习题 | 删除视奏练习题 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Pf.Subjects.Create | 添加练习题 | 添加练习题 |
| 2 | Pf.Subjects.Detail | 详情 | 练习题详情 |
| 3 | Pf.Subjects.List | 练习题列表 | 练习题列表 |
| 4 | Pf.Subjects.Delete | 删除题 | 删除题 |
| 5 | Pf.Subjects.DeleteQuestion | 删除选择题选项 | 删除指定的选择题选项 |
| 6 | Pf.Subjects.UpdateQuestion | 编辑选择题的选项 | 编辑选择题选项 |
| 7 | Pf.Subjects.PianoKeys | 获取钢琴88键配置 | 获取钢琴88键配置 |
| 8 | Pf.Subjects.UploadExcel | 上传Excel文件(导入题库) | 上传Excel文件-导入题库 |
| 9 | Pf.Subjects.SetJXGroup | 集训分组 | 集训分组 |
| 10 | Pf.Subjects.SetJXDailianGroup | //请检测函数注释 | //请使用@desc 注释 |
| 11 | Pf.Subjects.SetGroup | 添加/编辑阶位分组 | 添加/编辑 阶位分组 |
| 12 | Pf.Subjects.DelGroup | 删除分组 | 按分组id删除分组 |
| 13 | Pf.Subjects.GroupList | 分组列表 | 分组列表 |
| 14 | Pf.Subjects.BindSubjects | 题库组绑定题目 | 题库组绑定题目 |
| 15 | Pf.Subjects.Subjects | 获取题目（绑定页面 调用该接口，获取可绑定的题目） | 获取可绑定的题目 |
| 16 | Pf.Subjects.GroupShow | 题库组详情 | 题库组详情 |
| 17 | Pf.Subjects.GroupsOption | 根据游戏和阶位获取对应的分组列表 | 根据游戏id和阶位id获取对应的分组（课程内容页面，选择游戏或带练时调用该接口） |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Wechat.AbilityTypes.List | 能力列表 | 能力列表 |
| 2 | Wechat.AbilityTypes.Show | 查看详情 | 查看详情 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Wechat.Debug.Clean | 按手机号清除用户数据 | 按手机号清除用户数据，如果不传手机号，则清空所有特定的用户数据 |
| 2 | Wechat.Debug.SetEval | 设置测评报告状态为 有测评报告 | 设置测评报告状态 |
| 3 | Wechat.Debug.ResetUser | [crm原有用户] 与 [小程序新用户]绑定 | crm原有用户 与 小程序新用户绑定 |
| 4 | Wechat.Debug.CheckUser | 根据uid或手机号查询三个系统的用户 | 根据uid或手机号查询三个系统的用户 |
| 5 | Wechat.Debug.GetUserRank | //请检测函数注释 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Wechat.HomeWork.List | 分页课后作业 | 分页课后作业 |
| 2 | Wechat.HomeWork.Show | 查看作业详情 | 查看作业详情 |
| 3 | Wechat.HomeWork.SetStatus | 完成作业,变更作业状态 | 完成作业,变更作业状态 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Wechat.Job.InitPets | 初始化宠物 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Wechat.Pets.Show | 查看详情 | 查看详情 |
| 2 | Wechat.Pets.Upgrade | 升级宝贝 | 升级宝贝 |
| 3 | Wechat.Pets.SetPet | 选择宠物 | 用户选择宠物后 调用该接口 |
| 4 | Wechat.Pets.List | 宠物列表 | 用户宠物列表 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Wechat.Users.Add | 新增编辑 | 新增编辑 |
| 2 | Wechat.Users.Show | 查看用户详情 | 查看用户详情 |
| 3 | Wechat.Users.Team | 战队列表信息 | 战队列表信息 |
| 4 | Wechat.Users.AddExercises | 新增或更新自测试题状态 | 新增或更新自测试题状态 |
| 5 | Wechat.Users.ReadEval | 用户点击信封后调用该API | 用户点击阅读信封后调用该API |
| 6 | Wechat.Users.GetPhone | 从微信获取用户的手机号 | 从微信获取用户的手机号 |
| 7 | Wechat.Users.Qrcode | 获取机构 销售老师的二维码 | 获取机构 销售老师的二维码 |
| 8 | Wechat.Users.GetMaterials | 获取所学教材、考级 | //请使用@desc 注释 |
| 9 | Wechat.Users.GetRankValue | 获取小程序随机数据 | 获取小程序随机数据 |
| 10 | Wechat.Users.GetEval | @deprecated | 获取学员测评报告结果 |
| 11 | Wechat.Users.GetColorList | 获取阶位下的字段和颜色 | 获取阶位下的字段和颜色 |
| 12 | Wechat.Users.Eval | //请检测函数注释 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Wechat.WechatLogin.Info | 根据老师id获取 机构和老师信息 | 根据老师id获取机构和老师信息 |
| 2 | Wechat.WechatLogin.Login | 根据wx.login获取到code后调用该接口获取token | 通过wx.login获取到code后调用该接口获取token，判断是否是新用户，判断是否设置过昵称和琴龄 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Music.Rhythm.Demo | demo | demo |
| 2 | Music.Rhythm.Test | //请检测函数注释 | //请使用@desc 注释 |
| 序号 | API Service | API Title | API Description |
|---|---|---|---|
| 1 | Music.Xml.Demo | 按系统默认参数随机生成曲谱 | 按系统默认参数随机生成曲谱 |
| 2 | Music.Xml.Create | 自动生成xml乐谱接口 | 自动生成xml乐谱接口，注意：拍号格式；关于音域,1)默认音域范围用-隔开；2）如果想换手（单行谱表），musicRange音域为两段，格式：c-d1,b-a1。（英文逗号隔开）并且需要配合changeHandNum字段，即指定多少个音换手； |
| 3 | Music.Xml.UploadXml | 上传xml文件 | 上传xml文件到OSS服务器，并将上传纪录存在数据库。默认可上传任何类型的文件，可通过修改接口参数配置限制文件类型。 |
东梦接口平台
|
best choice to build cloud platform
© 2018-2025 Powered By dmapi v3.8.0 All Rights Reserved. 浙ICP备2024077538号-1