轻速云在线培训考试系统帮助文档

# 线下培训

# 培训班列表

# 功能说明

分页查询当前开放接口签名用户可见的培训班列表。

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/offlineTrainClassList

方式：get

# 请求参数

名称 类型 是否必选 示例值 描述
factoryCode String 是 123456 组织编号
sign String 是 eyJhbGciOiJIUzI1NiJ9 签名
pageNum Integer 是 1 请求页码
pageSize Integer 是 10 每页条数，最大1000
className String 否 培训班 培训班名称、创建人、内容或地址关键词
classifyPath String 否 2/3/ 分类路径编号，传参需要URL编码
hostDept String 否 1/5/ 主办部门路径，传参需要URL编码
status Integer 否 1 发布状态：0.未发布；1.已发布
classState Integer 否 0 培训班状态：0.未结班；1.已结班；2.已归档
startTime Date 否 1751328000000 开始时间下限
endTime Date 否 1753920000000 结束时间上限

# 返回数据

名称 类型 示例值 描述
code String 200 状态码，详见说明
body json 如下字段 培训班分页信息
total Integer 109 总条数
pageNum Integer 1 请求页码
pageSize Integer 10 每页条数
size Integer 10 当前页的记录数
isFirstPage Boolean true 当前页是否是第一页
isLastPage Boolean false 当前页是否是最后一页
list Array 如下字段 培训班列表
id String f6b5e017b79041a1bcc241915557085d 培训班ID
className String 培训班0723 培训班名称
classifyPath String 2/3/ 分类路径
classifyName String 新员工培训 分类名称
classTarget String 新员工 培训对象
classGoal String 熟悉业务流程 培训目的
classContent String 培训内容 培训内容
classPlace String 会议室A 培训地址
hostDept String 1/5/ 主办部门
hostDeptName String 培训部 主办部门名称
organizeDept String 1/8/ 承办部门
organizeDeptName String 人力资源部 承办部门名称
classNumber Integer 30 预计人数
managerId String 60d063e5e85a4ba792c468094cc1875d 负责人ID
managerName String 刘禹锡 负责人姓名
startTime Date 1751328000000 开始时间，时间戳
endTime Date 1753920000000 结束时间，时间戳
status Integer 1 发布状态：0.未发布；1.已发布
classState Integer 0 培训班状态：0.未结班；1.已结班；2.已归档
signFlag Integer 3 签到签退设置：1.不用签到签退；2.需要签到不用签退；3.需要签到和签退
signRule Integer 2 签到签退规则：1.按培训班签到签退；2.按课程签到签退
signType Integer 3 签到签退方式：1.手机；2.扫码；3.全部
elementInfoList Array 如下字段 培训班自定义信息字段列表

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/offlineTrainClassList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10&className=%E5%9F%B9%E8%AE%AD%E7%8F%AD

正常返回示例

JSON格式

{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 1,
        "nextPage": 2,
        "total": 109,
        "pages": 109,
        "list": [
            {
                "id": "f6b5e017b79041a1bcc241915557085d",
                "className": "培训班0723",
                "classPlace": "",
                "startTime": 1751328000000,
                "endTime": 1753920000000,
                "status": 1,
                "classState": 0,
                "signFlag": 3,
                "signRule": 2,
                "signType": 3,
                "hostDeptName": "",
                "organizeDeptName": "",
                "elementInfoList": []
            }
        ],
        "isLastPage": false,
        "size": 109,
        "isFirstPage": true
    }
}

# 培训班基础信息查询

# 功能说明

查询指定培训班基础信息，并返回培训班扩展设置和自定义信息字段。

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/offlineTrainClassDetail

方式：get

# 请求参数

名称 类型 是否必选 示例值 描述
factoryCode String 是 123456 组织编号
sign String 是 eyJhbGciOiJIUzI1NiJ9 签名
classId String f6b5e017b79041a1bcc241915557085d 培训班ID

# 返回数据

名称 类型 示例值 描述
code String 200 状态码，详见说明
body json 如下字段 培训班基础信息
id String f6b5e017b79041a1bcc241915557085d 培训班ID
className String 培训班0723 培训班名称
classPlace String 会议室A 培训地址
startTime Date 1751328000000 开始时间，时间戳
endTime Date 1753920000000 结束时间，时间戳
status Integer 1 发布状态：0.未发布；1.已发布
classState Integer 0 培训班状态：0.未结班；1.已结班；2.已归档
signFlag Integer 3 签到签退设置：1.不用签到签退；2.需要签到不用签退；3.需要签到和签退
signRule Integer 2 签到签退规则：1.按培训班签到签退；2.按课程签到签退
signType Integer 3 签到签退方式：1.手机；2.扫码；3.全部
jsonData json 如下字段 培训班扩展设置
needSignature Integer 0 是否需要签名：0.否；1.是
attendType Integer 2 参与方式设置
finishEnable Integer 1 是否开启完成条件
finishState Integer 1 培训班完成状态设置
finishTypes Array [3,4] 培训班完成条件
courseFinishState Integer 1 课程完成状态设置
courseFinishTypes Array [3,1,4] 课程完成条件
signTimeType Integer 1 签到签退时间类型
elementInfoList Array 如下字段 培训班自定义信息字段列表

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/offlineTrainClassDetail?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&classId=f6b5e017b79041a1bcc241915557085d

正常返回示例

JSON格式

{
    "code": "200",
    "body": {
        "id": "f6b5e017b79041a1bcc241915557085d",
        "className": "培训班0723",
        "classPlace": "",
        "startTime": 1751328000000,
        "endTime": 1753920000000,
        "status": 1,
        "classState": 0,
        "signFlag": 3,
        "signRule": 2,
        "signType": 3,
        "hostDeptName": "",
        "organizeDeptName": "",
        "jsonData": {
            "signTimeType": 1,
            "attendType": 2,
            "needSignature": 0,
            "finishEnable": 1,
            "finishState": 1,
            "finishTypes": [
                3,
                4
            ],
            "courseFinishState": 1,
            "courseFinishTypes": [
                3,
                1,
                4
            ]
        },
        "elementInfoList": []
    }
}

# 培训班签到签退记录列表

# 功能说明

分页查询指定培训班下的培训班签到和课程签到记录。

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/offlineTrainClassSignInRecordList

方式：get

# 请求参数

名称 类型 是否必选 示例值 描述
factoryCode String 是 123456 组织编号
sign String 是 eyJhbGciOiJIUzI1NiJ9 签名
classId String f6b5e017b79041a1bcc241915557085d 培训班ID
pageNum Integer 是 1 请求页码
pageSize Integer 是 10 每页条数，最大1000

# 返回数据

名称 类型 示例值 描述
code String 200 状态码，详见说明
body json 如下字段 签到签退记录分页信息
total Integer 3 总条数
pageNum Integer 1 请求页码
pageSize Integer 10 每页条数
size Integer 10 当前页的记录数
isFirstPage Boolean true 当前页是否是第一页
isLastPage Boolean true 当前页是否是最后一页
list Array 如下字段 签到签退记录列表
id Integer 258 签到记录ID
userId String 2843ccde67634a6191223ee3a6b3e381 用户ID
userCode String 1002 账号
nickName String 龙葵 姓名
classId String f6b5e017b79041a1bcc241915557085d 培训班ID
courseId String 943483e1d0b942aebcf8e4b17f7d4b03 课程ID，培训班签到时为空
title String 课程test 课程名称
signInTime Date 1753266500000 签到时间，时间戳
signInLocation String 北京市朝阳区 签到地点
signInSignaturePhoto String https://cdn.qingsuyun.com/sign-in.png 签到签名图片地址，未上传时不返回
signOutTime Date 1753269900000 签退时间，时间戳
signOutLocation String 北京市朝阳区 签退地点
signOutSignaturePhoto String https://cdn.qingsuyun.com/sign-out.png 签退签名图片地址，未上传时不返回
thirdId String third001 第三方ID
thirdType Integer 8 第三方类型

说明：签到签名图片通过 signInSignaturePhoto 返回，签退签名图片通过 signOutSignaturePhoto 返回；未上传图片或无对应签到/签退信息时，字段可能不返回。

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/offlineTrainClassSignInRecordList?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&classId=f6b5e017b79041a1bcc241915557085d&pageNum=1&pageSize=10

正常返回示例

JSON格式

{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 3,
        "total": 3,
        "pages": 1,
        "list": [
            {
                "id": 258,
                "userId": "2843ccde67634a6191223ee3a6b3e381",
                "userCode": "1002",
                "nickName": "龙葵",
                "classId": "f6b5e017b79041a1bcc241915557085d",
                "courseId": "943483e1d0b942aebcf8e4b17f7d4b03",
                "title": "课程test",
                "signInTime": 1753266500000,
                "signInLocation": "北京市朝阳区",
                "signInSignaturePhoto": "https://cdn.qingsuyun.com/sign-in.png",
                "signOutTime": 1753269900000,
                "signOutLocation": "北京市朝阳区",
                "signOutSignaturePhoto": "https://cdn.qingsuyun.com/sign-out.png",
                "thirdType": 8
            }
        ]
    }
}

← 学习地图管理 →