wsr/orange-admin
1
0
Fork 0
mirror of https://gitee.com/orangeform/orange-admin.git synced 2026-01-18 02:56:30 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
da61fae0e7a94eab7c03cce067cefd2558560d67
orange-admin/orange-demo-single-service-for-app/zz-resource/api-docs/Api-Doc.md
Jerry c87fb476d6 commit：支持app的纯后台服务
2020-10-29 18:55:12 +08:00

41 KiB
Raw Blame History

用户登录

登录接口

登录

  • URI: /admin/upms/login/doLogin
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    loginName string true 用户名
    password string true 加密后的用户密码

退出

  • URI: /admin/upms/login/logout
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token

修改密码

  • URI: /admin/upms/login/changePassword
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    oldPass string true 加密后的原用户密码
    newPass string true 加密后的新用户密码

用户权限模块

SysUserController

add

  • URI: /admin/upms/sysUser/add
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "sysUser" : {
        "loginName" : "String | true | 登录用户名。",
        "password" : "String | true | 用户密码。",
        "showName" : "String | true | 用户显示名称。",
        "userType" : "Integer | true | 用户类型(0: 管理员 1: 系统管理用户 2: 系统业务用户)。",
        "headImageUrl" : "String | false | 用户头像的Url。",
        "userStatus" : "Integer | true | 用户状态(0: 正常 1: 锁定)。",
        "createUserId" : "Long | false | 创建用户Id。",
        "createUsername" : "String | false | 创建用户名。",
        "createTime" : "Date | false | 创建时间。",
        "updateTime" : "Date | false | 更新时间。"
    }
}

update

  • URI: /admin/upms/sysUser/update
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "sysUser" : {
        "userId" : "Long | true | 用户Id。",
        "loginName" : "String | true | 登录用户名。",
        "password" : "String | true | 用户密码。",
        "showName" : "String | true | 用户显示名称。",
        "userType" : "Integer | true | 用户类型(0: 管理员 1: 系统管理用户 2: 系统业务用户)。",
        "headImageUrl" : "String | false | 用户头像的Url。",
        "userStatus" : "Integer | true | 用户状态(0: 正常 1: 锁定)。",
        "createUserId" : "Long | false | 创建用户Id。",
        "createUsername" : "String | false | 创建用户名。",
        "createTime" : "Date | false | 创建时间。",
        "updateTime" : "Date | false | 更新时间。"
    }
}

resetPassword

  • URI: /admin/upms/sysUser/resetPassword
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "userId" : "Long | true | 指定用户主键Id。"
}

delete

  • URI: /admin/upms/sysUser/delete
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "userId" : "Long | true | 删除对象主键Id。"
}

list

  • URI: /admin/upms/sysUser/list
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "sysUserFilter" : {
        "loginName" : "String | false | 登录用户名。",
        "showName" : "String | false | 用户显示名称。",
        "userStatus" : "Integer | false | 用户状态(0: 正常 1: 锁定)。",
        "createTimeStart" : "String | false | createTime 范围过滤起始值(>=)。",
        "createTimeEnd" : "String | false | createTime 范围过滤结束值(<=)。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

view

  • URI: /admin/upms/sysUser/view
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    userId Long true 指定对象主键Id。

业务应用模块

AreaCodeController

listDictAreaCode

  • URI: /admin/app/areaCode/listDictAreaCode
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token

listDictAreaCodeByParentId

  • URI: /admin/app/areaCode/listDictAreaCodeByParentId
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    parentId Long false 上级行政区划Id。

CourseController

add

  • URI: /admin/app/course/add
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "course" : {
        "courseName" : "String | true | 课程名称。",
        "price" : "BigDecimal | true | 课程价格。",
        "description" : "String | false | 课程描述。",
        "difficulty" : "Integer | true | 课程难度(0: 容易 1: 普通 2: 很难)。",
        "gradeId" : "Integer | true | 年级Id。",
        "subjectId" : "Integer | true | 学科Id。",
        "classHour" : "Integer | true | 课时数量。",
        "pictureUrl" : "String | true | 多张课程图片地址。",
        "createUserId" : "Long | false | 创建用户Id。",
        "createTime" : "Date | false | 创建时间。",
        "updateTime" : "Date | false | 最后修改时间。"
    }
}

update

  • URI: /admin/app/course/update
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "course" : {
        "courseId" : "Long | true | 主键Id。",
        "courseName" : "String | true | 课程名称。",
        "price" : "BigDecimal | true | 课程价格。",
        "description" : "String | false | 课程描述。",
        "difficulty" : "Integer | true | 课程难度(0: 容易 1: 普通 2: 很难)。",
        "gradeId" : "Integer | true | 年级Id。",
        "subjectId" : "Integer | true | 学科Id。",
        "classHour" : "Integer | true | 课时数量。",
        "pictureUrl" : "String | true | 多张课程图片地址。",
        "createUserId" : "Long | false | 创建用户Id。",
        "createTime" : "Date | false | 创建时间。",
        "updateTime" : "Date | false | 最后修改时间。"
    }
}

delete

  • URI: /admin/app/course/delete
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "courseId" : "Long | true | 删除对象主键Id。"
}

list

  • URI: /admin/app/course/list
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "courseFilter" : {
        "courseName" : "String | false | 课程名称。",
        "difficulty" : "Integer | false | 课程难度(0: 容易 1: 普通 2: 很难)。",
        "gradeId" : "Integer | false | 年级Id。",
        "subjectId" : "Integer | false | 学科Id。",
        "priceStart" : "BigDecimal | false | price 范围过滤起始值(>=)。",
        "priceEnd" : "BigDecimal | false | price 范围过滤结束值(<=)。",
        "classHourStart" : "Integer | false | classHour 范围过滤起始值(>=)。",
        "classHourEnd" : "Integer | false | classHour 范围过滤结束值(<=)。",
        "createTimeStart" : "String | false | createTime 范围过滤起始值(>=)。",
        "createTimeEnd" : "String | false | createTime 范围过滤结束值(<=)。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

view

  • URI: /admin/app/course/view
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    courseId Long true 指定对象主键Id。

download

  • URI: /admin/app/course/download
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    courseId Long false 附件所在记录的主键Id。
    fieldName String true 附件所属的字段名。
    filename String true 文件名。如果没有提供该参数，就从当前记录的指定字段中读取。
    asImage Boolean true 下载文件是否为图片。

upload

  • URI: /admin/app/course/upload
  • Type: POST
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    fieldName String true 上传文件名。
    asImage Boolean true 是否作为图片上传。如果是图片，今后下载的时候无需权限验证。否则就是附件上传，下载时需要权限验证。
    uploadFile File true 上传文件对象。

listDictCourse

  • URI: /admin/app/course/listDictCourse
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    courseId Long false 主键Id。
    courseName String false 课程名称。
    price BigDecimal false 课程价格。
    description String false 课程描述。
    difficulty Integer false 课程难度(0: 容易 1: 普通 2: 很难)。
    gradeId Integer false 年级Id。
    subjectId Integer false 学科Id。
    classHour Integer false 课时数量。
    pictureUrl String false 多张课程图片地址。
    createUserId Long false 创建用户Id。
    createTime Date false 创建时间。
    updateTime Date false 最后修改时间。

CourseTransStatsController

list

  • URI: /admin/app/courseTransStats/list
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "courseTransStatsFilter" : {
        "subjectId" : "Integer | false | 科目Id。",
        "gradeId" : "Integer | false | 年级Id。",
        "statsDateStart" : "String | false | statsDate 范围过滤起始值(>=)。",
        "statsDateEnd" : "String | false | statsDate 范围过滤结束值(<=)。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

listWithGroup

  • URI: /admin/app/courseTransStats/listWithGroup
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "courseTransStatsFilter" : {
        "subjectId" : "Integer | false | 科目Id。",
        "gradeId" : "Integer | false | 年级Id。",
        "statsDateStart" : "String | false | statsDate 范围过滤起始值(>=)。",
        "statsDateEnd" : "String | false | statsDate 范围过滤结束值(<=)。"
    },
    "groupParam" : [
        {
            "fieldName" : "String | false | 分组字段名",
            "aliasName" : "String | false | 分组字段别名",
            "dateAggregateBy" : "String | false | 是否按照日期聚合，可选项(day|month|year)"
        }
    ],
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

view

  • URI: /admin/app/courseTransStats/view
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    statsId Long true 指定对象主键Id。

GradeController

add

  • URI: /admin/app/grade/add
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "grade" : {
        "gradeName" : "String | true | 年级名称。"
    }
}

update

  • URI: /admin/app/grade/update
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "grade" : {
        "gradeId" : "Integer | true | 主键Id。",
        "gradeName" : "String | true | 年级名称。"
    }
}

delete

  • URI: /admin/app/grade/delete
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "gradeId" : "Integer | true | 删除对象主键Id。"
}

listDictGrade

  • URI: /admin/app/grade/listDictGrade
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token

reloadCachedData

  • URI: /admin/app/grade/reloadCachedData
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token

SchoolInfoController

add

  • URI: /admin/app/schoolInfo/add
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "schoolInfo" : {
        "schoolName" : "String | true | 学校名称。",
        "provinceId" : "Long | true | 所在省Id。",
        "cityId" : "Long | true | 所在城市Id。"
    }
}

update

  • URI: /admin/app/schoolInfo/update
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "schoolInfo" : {
        "schoolId" : "Long | true | 学校Id。",
        "schoolName" : "String | true | 学校名称。",
        "provinceId" : "Long | true | 所在省Id。",
        "cityId" : "Long | true | 所在城市Id。"
    }
}

delete

  • URI: /admin/app/schoolInfo/delete
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "schoolId" : "Long | true | 删除对象主键Id。"
}

list

  • URI: /admin/app/schoolInfo/list
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "schoolInfoFilter" : {
        "schoolName" : "String | false | 学校名称。",
        "provinceId" : "Long | false | 所在省Id。",
        "cityId" : "Long | false | 所在城市Id。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

view

  • URI: /admin/app/schoolInfo/view
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    schoolId Long true 指定对象主键Id。

listDictSchoolInfo

  • URI: /admin/app/schoolInfo/listDictSchoolInfo
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    schoolId Long false 学校Id。
    schoolName String false 学校名称。
    provinceId Long false 所在省Id。
    cityId Long false 所在城市Id。

StudentActionStatsController

list

  • URI: /admin/app/studentActionStats/list
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentActionStatsFilter" : {
        "gradeId" : "Integer | false | 年级Id。",
        "provinceId" : "Long | false | 学生所在省Id。",
        "cityId" : "Long | false | 学生所在城市Id。",
        "statsDateStart" : "String | false | statsDate 范围过滤起始值(>=)。",
        "statsDateEnd" : "String | false | statsDate 范围过滤结束值(<=)。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

listWithGroup

  • URI: /admin/app/studentActionStats/listWithGroup
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentActionStatsFilter" : {
        "gradeId" : "Integer | false | 年级Id。",
        "provinceId" : "Long | false | 学生所在省Id。",
        "cityId" : "Long | false | 学生所在城市Id。",
        "statsDateStart" : "String | false | statsDate 范围过滤起始值(>=)。",
        "statsDateEnd" : "String | false | statsDate 范围过滤结束值(<=)。"
    },
    "groupParam" : [
        {
            "fieldName" : "String | false | 分组字段名",
            "aliasName" : "String | false | 分组字段别名",
            "dateAggregateBy" : "String | false | 是否按照日期聚合，可选项(day|month|year)"
        }
    ],
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

view

  • URI: /admin/app/studentActionStats/view
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    statsId Long true 指定对象主键Id。

StudentActionTransController

add

  • URI: /admin/app/studentActionTrans/add
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentActionTrans" : {
        "studentId" : "Long | true | 学生Id。",
        "studentName" : "String | true | 学生名称。",
        "schoolId" : "Long | true | 学生校区。",
        "gradeId" : "Integer | true | 年级Id。",
        "actionType" : "Integer | true | 行为类型(0: 充值  1: 购课 2: 上课签到 3: 上课签退 4: 看视频课 5: 做作业 6: 刷题 7: 献花)。",
        "deviceType" : "Integer | true | 设备类型(0: iOS 1: Android 2: PC)。",
        "watchVideoSeconds" : "Integer | false | 看视频秒数。",
        "flowerCount" : "Integer | false | 购买献花数量。",
        "paperCount" : "Integer | false | 购买作业数量。",
        "videoCount" : "Integer | false | 购买视频数量。",
        "courseCount" : "Integer | false | 购买课程数量。",
        "coinCount" : "Integer | false | 充值学币数量。",
        "exerciseCorrectFlag" : "Integer | false | 做题是否正确标记。",
        "createTime" : "Date | true | 发生时间。"
    }
}

update

  • URI: /admin/app/studentActionTrans/update
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentActionTrans" : {
        "transId" : "Long | true | 主键Id。",
        "studentId" : "Long | true | 学生Id。",
        "studentName" : "String | true | 学生名称。",
        "schoolId" : "Long | true | 学生校区。",
        "gradeId" : "Integer | true | 年级Id。",
        "actionType" : "Integer | true | 行为类型(0: 充值  1: 购课 2: 上课签到 3: 上课签退 4: 看视频课 5: 做作业 6: 刷题 7: 献花)。",
        "deviceType" : "Integer | true | 设备类型(0: iOS 1: Android 2: PC)。",
        "watchVideoSeconds" : "Integer | false | 看视频秒数。",
        "flowerCount" : "Integer | false | 购买献花数量。",
        "paperCount" : "Integer | false | 购买作业数量。",
        "videoCount" : "Integer | false | 购买视频数量。",
        "courseCount" : "Integer | false | 购买课程数量。",
        "coinCount" : "Integer | false | 充值学币数量。",
        "exerciseCorrectFlag" : "Integer | false | 做题是否正确标记。",
        "createTime" : "Date | true | 发生时间。"
    }
}

delete

  • URI: /admin/app/studentActionTrans/delete
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "transId" : "Long | true | 删除对象主键Id。"
}

list

  • URI: /admin/app/studentActionTrans/list
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentActionTransFilter" : {
        "studentId" : "Long | false | 学生Id。",
        "schoolId" : "Long | false | 学生校区。",
        "gradeId" : "Integer | false | 年级Id。",
        "actionType" : "Integer | false | 行为类型(0: 充值  1: 购课 2: 上课签到 3: 上课签退 4: 看视频课 5: 做作业 6: 刷题 7: 献花)。",
        "deviceType" : "Integer | false | 设备类型(0: iOS 1: Android 2: PC)。",
        "createTimeStart" : "String | false | createTime 范围过滤起始值(>=)。",
        "createTimeEnd" : "String | false | createTime 范围过滤结束值(<=)。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

view

  • URI: /admin/app/studentActionTrans/view
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    transId Long true 指定对象主键Id。

StudentClassController

add

  • URI: /admin/app/studentClass/add
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentClass" : {
        "className" : "String | true | 班级名称。",
        "schoolId" : "Long | true | 学校Id。",
        "leaderId" : "Long | true | 学生班长Id。",
        "finishClassHour" : "Integer | true | 已完成课时数量。",
        "classLevel" : "Integer | true | 班级级别(0: 初级班 1: 培优班 2: 冲刺提分班 3: 竞赛班)。",
        "createUserId" : "Long | false | 创建用户。",
        "createTime" : "Date | false | 班级创建时间。"
    }
}

update

  • URI: /admin/app/studentClass/update
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentClass" : {
        "classId" : "Long | true | 班级Id。",
        "className" : "String | true | 班级名称。",
        "schoolId" : "Long | true | 学校Id。",
        "leaderId" : "Long | true | 学生班长Id。",
        "finishClassHour" : "Integer | true | 已完成课时数量。",
        "classLevel" : "Integer | true | 班级级别(0: 初级班 1: 培优班 2: 冲刺提分班 3: 竞赛班)。",
        "createUserId" : "Long | false | 创建用户。",
        "createTime" : "Date | false | 班级创建时间。"
    }
}

delete

  • URI: /admin/app/studentClass/delete
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 删除对象主键Id。"
}

list

  • URI: /admin/app/studentClass/list
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentClassFilter" : {
        "className" : "String | false | 班级名称。",
        "schoolId" : "Long | false | 学校Id。",
        "classLevel" : "Integer | false | 班级级别(0: 初级班 1: 培优班 2: 冲刺提分班 3: 竞赛班)。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

view

  • URI: /admin/app/studentClass/view
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    classId Long true 指定对象主键Id。

listNotInClassCourse

  • URI: /admin/app/studentClass/listNotInClassCourse
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 主表关联字段。",
    "courseFilter" : {
        "courseName" : "String | false | 课程名称。",
        "difficulty" : "Integer | false | 课程难度(0: 容易 1: 普通 2: 很难)。",
        "gradeId" : "Integer | false | 年级Id。",
        "subjectId" : "Integer | false | 学科Id。",
        "priceStart" : "BigDecimal | false | price 范围过滤起始值(>=)。",
        "priceEnd" : "BigDecimal | false | price 范围过滤结束值(<=)。",
        "classHourStart" : "Integer | false | classHour 范围过滤起始值(>=)。",
        "classHourEnd" : "Integer | false | classHour 范围过滤结束值(<=)。",
        "createTimeStart" : "String | false | createTime 范围过滤起始值(>=)。",
        "createTimeEnd" : "String | false | createTime 范围过滤结束值(<=)。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

listClassCourse

  • URI: /admin/app/studentClass/listClassCourse
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 主表关联字段。",
    "courseFilter" : {
        "courseName" : "String | false | 课程名称。",
        "difficulty" : "Integer | false | 课程难度(0: 容易 1: 普通 2: 很难)。",
        "gradeId" : "Integer | false | 年级Id。",
        "subjectId" : "Integer | false | 学科Id。",
        "priceStart" : "BigDecimal | false | price 范围过滤起始值(>=)。",
        "priceEnd" : "BigDecimal | false | price 范围过滤结束值(<=)。",
        "classHourStart" : "Integer | false | classHour 范围过滤起始值(>=)。",
        "classHourEnd" : "Integer | false | classHour 范围过滤结束值(<=)。",
        "createTimeStart" : "String | false | createTime 范围过滤起始值(>=)。",
        "createTimeEnd" : "String | false | createTime 范围过滤结束值(<=)。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

addClassCourse

  • URI: /admin/app/studentClass/addClassCourse
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 主表主键Id。",
    "classCourseList" : [
        {
            "classId" : "Long | true | 班级Id。",
            "courseId" : "Long | true | 课程Id。",
            "courseOrder" : "Integer | true | 课程顺序(数值越小越靠前)。"
        }
    ]
}

updateClassCourse

  • URI: /admin/app/studentClass/updateClassCourse
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classCourse" : {
        "classId" : "Long | true | 班级Id。",
        "courseId" : "Long | true | 课程Id。",
        "courseOrder" : "Integer | true | 课程顺序(数值越小越靠前)。"
    }
}

viewClassCourse

  • URI: /admin/app/studentClass/viewClassCourse
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    classId Long true 主表主键Id。
    courseId Long true 从表主键Id。

deleteClassCourse

  • URI: /admin/app/studentClass/deleteClassCourse
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 主表主键Id。",
    "courseId" : "Long | true | 从表主键Id。"
}

listNotInClassStudent

  • URI: /admin/app/studentClass/listNotInClassStudent
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 主表关联字段。",
    "studentFilter" : {
        "provinceId" : "Long | false | 所在省份Id。",
        "cityId" : "Long | false | 所在城市Id。",
        "districtId" : "Long | false | 区县Id。",
        "gradeId" : "Integer | false | 年级Id。",
        "schoolId" : "Long | false | 校区Id。",
        "status" : "Integer | false | 学生状态 (0: 正常 1: 锁定 2: 注销)。",
        "birthdayStart" : "String | false | birthday 范围过滤起始值(>=)。",
        "birthdayEnd" : "String | false | birthday 范围过滤结束值(<=)。",
        "registerTimeStart" : "String | false | registerTime 范围过滤起始值(>=)。",
        "registerTimeEnd" : "String | false | registerTime 范围过滤结束值(<=)。",
        "searchString" : "String | false | 模糊搜索字符串。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

listClassStudent

  • URI: /admin/app/studentClass/listClassStudent
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 主表关联字段。",
    "studentFilter" : {
        "provinceId" : "Long | false | 所在省份Id。",
        "cityId" : "Long | false | 所在城市Id。",
        "districtId" : "Long | false | 区县Id。",
        "gradeId" : "Integer | false | 年级Id。",
        "schoolId" : "Long | false | 校区Id。",
        "status" : "Integer | false | 学生状态 (0: 正常 1: 锁定 2: 注销)。",
        "birthdayStart" : "String | false | birthday 范围过滤起始值(>=)。",
        "birthdayEnd" : "String | false | birthday 范围过滤结束值(<=)。",
        "registerTimeStart" : "String | false | registerTime 范围过滤起始值(>=)。",
        "registerTimeEnd" : "String | false | registerTime 范围过滤结束值(<=)。",
        "searchString" : "String | false | 模糊搜索字符串。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

addClassStudent

  • URI: /admin/app/studentClass/addClassStudent
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 主表主键Id。",
    "classStudentList" : [
        {
            "classId" : "Long | true | 班级Id。",
            "studentId" : "Long | true | 学生Id。"
        }
    ]
}

deleteClassStudent

  • URI: /admin/app/studentClass/deleteClassStudent
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "classId" : "Long | true | 主表主键Id。",
    "studentId" : "Long | true | 从表主键Id。"
}

StudentController

add

  • URI: /admin/app/student/add
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "student" : {
        "loginMobile" : "String | true | 登录手机。",
        "studentName" : "String | true | 学生姓名。",
        "provinceId" : "Long | true | 所在省份Id。",
        "cityId" : "Long | true | 所在城市Id。",
        "districtId" : "Long | true | 区县Id。",
        "gender" : "Integer | true | 学生性别 (0: 女生 1: 男生)。",
        "birthday" : "Date | true | 生日。",
        "experienceLevel" : "Integer | true | 经验等级 (0: 初级 1: 中级 2: 高级 3: 资深)。",
        "totalCoin" : "Integer | true | 总共充值学币数量。",
        "leftCoin" : "Integer | true | 可用学币数量。",
        "gradeId" : "Integer | true | 年级Id。",
        "schoolId" : "Long | true | 校区Id。",
        "registerTime" : "Date | false | 注册时间。",
        "status" : "Integer | true | 学生状态 (0: 正常 1: 锁定 2: 注销)。"
    }
}

update

  • URI: /admin/app/student/update
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "student" : {
        "studentId" : "Long | true | 学生Id。",
        "loginMobile" : "String | true | 登录手机。",
        "studentName" : "String | true | 学生姓名。",
        "provinceId" : "Long | true | 所在省份Id。",
        "cityId" : "Long | true | 所在城市Id。",
        "districtId" : "Long | true | 区县Id。",
        "gender" : "Integer | true | 学生性别 (0: 女生 1: 男生)。",
        "birthday" : "Date | true | 生日。",
        "experienceLevel" : "Integer | true | 经验等级 (0: 初级 1: 中级 2: 高级 3: 资深)。",
        "totalCoin" : "Integer | true | 总共充值学币数量。",
        "leftCoin" : "Integer | true | 可用学币数量。",
        "gradeId" : "Integer | true | 年级Id。",
        "schoolId" : "Long | true | 校区Id。",
        "registerTime" : "Date | false | 注册时间。",
        "status" : "Integer | true | 学生状态 (0: 正常 1: 锁定 2: 注销)。"
    }
}

delete

  • URI: /admin/app/student/delete
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentId" : "Long | true | 删除对象主键Id。"
}

list

  • URI: /admin/app/student/list
  • Type: POST
  • Content-Type: application/json; chartset=utf-8
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Body:
{
    "studentFilter" : {
        "provinceId" : "Long | false | 所在省份Id。",
        "cityId" : "Long | false | 所在城市Id。",
        "districtId" : "Long | false | 区县Id。",
        "gradeId" : "Integer | false | 年级Id。",
        "schoolId" : "Long | false | 校区Id。",
        "status" : "Integer | false | 学生状态 (0: 正常 1: 锁定 2: 注销)。",
        "birthdayStart" : "String | false | birthday 范围过滤起始值(>=)。",
        "birthdayEnd" : "String | false | birthday 范围过滤结束值(<=)。",
        "registerTimeStart" : "String | false | registerTime 范围过滤起始值(>=)。",
        "registerTimeEnd" : "String | false | registerTime 范围过滤结束值(<=)。",
        "searchString" : "String | false | 模糊搜索字符串。"
    },
    "orderParam" : [
        {
            "fieldName" : "String | false | 排序字段名",
            "asc" : "Boolean | false | 是否升序"
        }
    ],
    "pageParam" : {
        "pageNum": "Integer | false | 分页页号",
        "pageSize": "Integer | false | 每页数据量"
    }
}

view

  • URI: /admin/app/student/view
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    studentId Long true 指定对象主键Id。

listDictStudent

  • URI: /admin/app/student/listDictStudent
  • Type: GET
  • Content-Type: multipart/form-data
  • Request-Headers:
    Name Type Description
    Authorization String 身份验证的Token
  • Request-Parameters:
    Parameter Type Required Description
    studentId Long false 学生Id。
    loginMobile String false 登录手机。
    studentName String false 学生姓名。
    provinceId Long false 所在省份Id。
    cityId Long false 所在城市Id。
    districtId Long false 区县Id。
    gender Integer false 学生性别 (0: 女生 1: 男生)。
    birthday Date false 生日。
    experienceLevel Integer false 经验等级 (0: 初级 1: 中级 2: 高级 3: 资深)。
    totalCoin Integer false 总共充值学币数量。
    leftCoin Integer false 可用学币数量。
    gradeId Integer false 年级Id。
    schoolId Long false 校区Id。
    registerTime Date false 注册时间。
    status Integer false 学生状态 (0: 正常 1: 锁定 2: 注销)。